omikit-plugin 4.1.0 → 4.1.2

package/README.md

@@ -2,7 +2,7 @@
 
 The [omikit-plugin](https://www.npmjs.com/package/omikit-plugin) enables VoIP/SIP calling via the OMICALL platform with support for both Old and **New Architecture** (TurboModules + Fabric).
 
-**Status:** Active maintenance | **Version:** 4.1.0
+**Status:** Active maintenance | **Version:** 4.1.1
 
 ---
 
@@ -46,7 +46,7 @@ The [omikit-plugin](https://www.npmjs.com/package/omikit-plugin) enables VoIP/SI
 
 | Platform | SDK | Version |
 |----------|-----|---------|
-| Android | OMIKIT | 2.6.4 |
+| Android | OMIKIT | 2.6.6 |
 | iOS | OmiKit | 1.11.4 |
 
 ### Platform Requirements
@@ -54,8 +54,8 @@ The [omikit-plugin](https://www.npmjs.com/package/omikit-plugin) enables VoIP/SI
 | | Android | iOS |
 |--|---------|-----|
 | **Min SDK** | API 24 (Android 7.0) | iOS 13.0 |
-| **Target SDK** | API 35 (Android 15) | — |
-| **Compile SDK** | API 35 | — |
+| **Target SDK** | API 36 (Android 16) | — |
+| **Compile SDK** | API 36 | — |
 
 ### Device Requirements
 
@@ -131,7 +131,32 @@ Add to `android/app/src/main/AndroidManifest.xml`:
 >
 > Make sure to add the `tools` namespace to your manifest tag: `xmlns:tools="http://schemas.android.com/tools"`
 
-### 2. Firebase Cloud Messaging (FCM)
+### 2. Incoming Call Activity (Required)
+
+Your main Activity must handle incoming call intents from the SDK. Add the following `intent-filter` to your `MainActivity` in `AndroidManifest.xml`:
+
+```xml
+<activity
+  android:name=".MainActivity"
+  android:showWhenLocked="true"
+  android:turnScreenOn="true"
+  android:launchMode="singleTask"
+  ...>
+
+  <!-- Incoming call intent-filter (required for lock screen) -->
+  <intent-filter>
+    <action android:name="${applicationId}.ACTION_INCOMING_CALL" />
+    <action android:name="android.intent.action.CALL" />
+    <category android:name="android.intent.category.DEFAULT" />
+    <data android:host="incoming_call" android:scheme="omisdk" />
+  </intent-filter>
+</activity>
+```
+
+> **Important:** The `${applicationId}.ACTION_INCOMING_CALL` action ensures incoming calls show correctly on **lock screen** for Android 9-14. Without this, the default dialer may intercept the intent instead of your app.
+
+### 3. Firebase Cloud Messaging (FCM)
+
 
 Add your `google-services.json` to `android/app/`.
 
@@ -141,7 +166,7 @@ In `android/app/build.gradle`:
 apply plugin: 'com.google.gms.google-services'
 ```
 
-### 3. Maven Repository
+### 4. Maven Repository
 
 **Option A — `settings.gradle.kts` (recommended for new projects)**
 
@@ -201,7 +226,7 @@ OMI_TOKEN=omi_github_access_token
 
 > **Note:** Contact the OMICall development team to get `OMI_USER` and `OMI_TOKEN` credentials.
 
-### 4. New Architecture (Optional)
+### 5. New Architecture (Optional)
 
 To enable New Architecture on Android, in `android/gradle.properties`:
 
@@ -238,13 +263,352 @@ Enable **Push Notifications** capability in Xcode for VoIP push (PushKit).
 
 ### 4. AppDelegate Setup
 
-In your `AppDelegate.mm` (or `.m`):
+The AppDelegate template differs depending on your React Native version. Choose the one that matches your project:
+
+#### RN 0.74 – 0.78 (RCTAppDelegate pattern)
+
+<details>
+<summary>AppDelegate.h</summary>
 
 ```objc
-#import <OmiKit/OmiKit-umbrella.h>
-#import <OmiKit/Constants.h>
+#import <RCTAppDelegate.h>
+#import <UIKit/UIKit.h>
+#import <UserNotifications/UserNotifications.h>
+#import <OmiKit/OmiKit.h>
+
+@interface AppDelegate : RCTAppDelegate <UIApplicationDelegate, RCTBridgeDelegate, UNUserNotificationCenterDelegate>
+
+@property (nonatomic, strong) UIWindow *window;
+@property (nonatomic, strong) PushKitManager *pushkitManager;
+@property (nonatomic, strong) CallKitProviderDelegate *provider;
+@property (nonatomic, strong) PKPushRegistry *voipRegistry;
+
+@end
 ```
 
+</details>
+
+<details>
+<summary>AppDelegate.mm</summary>
+
+```objc
+#import "AppDelegate.h"
+#import <Firebase.h>
+#import <React/RCTBundleURLProvider.h>
+#import <OmiKit/OmiKit.h>
+
+#if __has_include("OmikitNotification.h")
+#import "OmikitNotification.h"
+#else
+#import <omikit_plugin/OmikitNotification.h>
+#endif
+
+@implementation AppDelegate
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+  self.moduleName = @"YourAppName"; // Replace with your app name
+
+  // ----- OmiKit Config ------
+  [OmiClient setEnviroment:KEY_OMI_APP_ENVIROMENT_SANDBOX
+                userNameKey:@"full_name"
+                    maxCall:2
+               callKitImage:@"call_image"
+              typePushVoip:TYPE_PUSH_CALLKIT_DEFAULT];
+
+  self.provider = [[CallKitProviderDelegate alloc]
+      initWithCallManager:[OMISIPLib sharedInstance].callManager];
+  self.voipRegistry = [[PKPushRegistry alloc]
+      initWithQueue:dispatch_get_main_queue()];
+  self.pushkitManager = [[PushKitManager alloc]
+      initWithVoipRegistry:self.voipRegistry];
+
+  if (@available(iOS 10.0, *)) {
+    [UNUserNotificationCenter currentNotificationCenter].delegate =
+        (id<UNUserNotificationCenterDelegate>)self;
+  }
+
+  if ([FIRApp defaultApp] == nil) {
+    [FIRApp configure];
+  }
+  // ----- End OmiKit Config ------
+
+  return [super application:application didFinishLaunchingWithOptions:launchOptions];
+}
+
+// Handle foreground notifications
+- (void)userNotificationCenter:(UNUserNotificationCenter *)center
+       willPresentNotification:(UNNotification *)notification
+         withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler
+{
+  completionHandler(UNAuthorizationOptionSound | UNAuthorizationOptionAlert | UNAuthorizationOptionBadge);
+}
+
+// Handle missed call notification tap
+- (void)userNotificationCenter:(UNUserNotificationCenter *)center
+didReceiveNotificationResponse:(UNNotificationResponse *)response
+         withCompletionHandler:(void (^)())completionHandler
+{
+  NSDictionary *userInfo = response.notification.request.content.userInfo;
+  if (userInfo && [userInfo valueForKey:@"omisdkCallerNumber"]) {
+    [OmikitNotification didRecieve:userInfo];
+  }
+  completionHandler();
+}
+
+// Register push notification token
+- (void)application:(UIApplication *)app
+    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)devToken
+{
+  const unsigned char *data = (const unsigned char *)[devToken bytes];
+  NSMutableString *token = [NSMutableString string];
+  for (NSUInteger i = 0; i < [devToken length]; i++) {
+    [token appendFormat:@"%02.2hhX", data[i]];
+  }
+  [OmiClient setUserPushNotificationToken:[token copy]];
+}
+
+// Terminate all calls when app is killed
+- (void)applicationWillTerminate:(UIApplication *)application {
+  @try {
+    [OmiClient OMICloseCall];
+  } @catch (NSException *exception) {}
+}
+
+- (NSURL *)sourceURLForBridge:(RCTBridge *)bridge
+{
+  return [self bundleURL];
+}
+
+- (NSURL *)bundleURL
+{
+#if DEBUG
+  return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index"];
+#else
+  return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];
+#endif
+}
+
+@end
+```
+
+</details>
+
+#### RN 0.79+ (RCTReactNativeFactory pattern)
+
+RN 0.79+ uses `RCTReactNativeFactory` instead of `RCTAppDelegate`. Add OmiKit setup in your existing AppDelegate:
+
+<details>
+<summary>AppDelegate.swift (Swift template)</summary>
+
+```swift
+import UIKit
+import React
+import ReactAppDependencyProvider
+import OmiKit
+
+@main
+class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterDelegate {
+  var window: UIWindow?
+  var provider: CallKitProviderDelegate?
+  var pushkitManager: PushKitManager?
+  var voipRegistry: PKPushRegistry?
+
+  func application(_ application: UIApplication,
+                   didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+    // React Native setup
+    let delegate = ReactNativeDelegate()
+    let factory = RCTReactNativeFactory(delegate: delegate)
+    delegate.dependencyProvider = RCTAppDependencyProvider()
+
+    window = UIWindow(frame: UIScreen.main.bounds)
+    factory.startReactNative(
+      withModuleName: "YourAppName",
+      in: window,
+      launchOptions: launchOptions
+    )
+
+    // ----- OmiKit Config ------
+    #ifdef DEBUG
+    OmiClient.setEnviroment(KEY_OMI_APP_ENVIROMENT_SANDBOX,
+                            userNameKey: "full_name",
+                            maxCall: 1,
+                            callKitImage: "call_image",
+                            typePushVoip: TYPE_PUSH_CALLKIT_DEFAULT)
+    #else
+    OmiClient.setEnviroment(KEY_OMI_APP_ENVIROMENT_PRODUCTION,
+                            userNameKey: "full_name",
+                            maxCall: 1,
+                            callKitImage: "call_image",
+                            typePushVoip: TYPE_PUSH_CALLKIT_DEFAULT)
+    #endif
+
+    provider = CallKitProviderDelegate(callManager: OMISIPLib.sharedInstance().callManager)
+    voipRegistry = PKPushRegistry(queue: .main)
+    pushkitManager = PushKitManager(voipRegistry: voipRegistry!)
+
+    UNUserNotificationCenter.current().delegate = self
+    FirebaseApp.configure()
+    // ----- End OmiKit Config ------
+
+    return true
+  }
+
+  // Handle missed call notification tap
+  func userNotificationCenter(_ center: UNUserNotificationCenter,
+                              didReceive response: UNNotificationResponse,
+                              withCompletionHandler completionHandler: @escaping () -> Void) {
+    let userInfo = response.notification.request.content.userInfo
+    if userInfo["omisdkCallerNumber"] != nil {
+      OmikitNotification.didRecieve(userInfo)
+    }
+    completionHandler()
+  }
+
+  // Register push notification token
+  func application(_ application: UIApplication,
+                   didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
+    let token = deviceToken.map { String(format: "%02.2hhX", $0) }.joined()
+    OmiClient.setUserPushNotificationToken(token)
+  }
+
+  // Terminate all calls when app is killed
+  func applicationWillTerminate(_ application: UIApplication) {
+    try? OmiClient.omiCloseCall()
+  }
+}
+
+class ReactNativeDelegate: RCTDefaultReactNativeFactoryDelegate {
+  override func sourceURL(for bridge: RCTBridge) -> URL? {
+    return bundleURL()
+  }
+
+  override func bundleURL() -> URL? {
+    #if DEBUG
+    return RCTBundleURLProvider.sharedSettings().jsBundleURL(forBundleRoot: "index")
+    #else
+    return Bundle.main.url(forResource: "main", withExtension: "jsbundle")
+    #endif
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>AppDelegate.mm (Objective-C template)</summary>
+
+```objc
+#import "AppDelegate.h"
+#import <Firebase.h>
+#import <React/RCTBundleURLProvider.h>
+#import <React/RCTReactNativeFactory.h>
+#import <ReactAppDependencyProvider/RCTAppDependencyProvider.h>
+#import <OmiKit/OmiKit.h>
+
+#if __has_include("OmikitNotification.h")
+#import "OmikitNotification.h"
+#else
+#import <omikit_plugin/OmikitNotification.h>
+#endif
+
+@interface ReactNativeDelegate : RCTDefaultReactNativeFactoryDelegate
+@end
+
+@implementation AppDelegate
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+  ReactNativeDelegate *delegate = [ReactNativeDelegate new];
+  RCTReactNativeFactory *factory = [[RCTReactNativeFactory alloc] initWithDelegate:delegate];
+  delegate.dependencyProvider = [RCTAppDependencyProvider new];
+
+  self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
+  [factory startReactNativeWithModuleName:@"YourAppName" in:self.window launchOptions:launchOptions];
+
+  // ----- OmiKit Config ------
+  #ifdef DEBUG
+        [OmiClient setEnviroment:KEY_OMI_APP_ENVIROMENT_SANDBOX userNameKey:@"full_name" maxCall:1 callKitImage:@"icYourApp" typePushVoip:@"background"];
+  #else
+        [OmiClient setEnviroment:KEY_OMI_APP_ENVIROMENT_PRODUCTION userNameKey:@"full_name" maxCall:1 callKitImage:@"icYourApp" typePushVoip:@"background"];
+  #endif
+
+  self.provider = [[CallKitProviderDelegate alloc]
+      initWithCallManager:[OMISIPLib sharedInstance].callManager];
+  self.voipRegistry = [[PKPushRegistry alloc]
+      initWithQueue:dispatch_get_main_queue()];
+  self.pushkitManager = [[PushKitManager alloc]
+      initWithVoipRegistry:self.voipRegistry];
+
+  if (@available(iOS 10.0, *)) {
+    [UNUserNotificationCenter currentNotificationCenter].delegate =
+        (id<UNUserNotificationCenterDelegate>)self;
+  }
+
+  if ([FIRApp defaultApp] == nil) {
+    [FIRApp configure];
+  }
+  // ----- End OmiKit Config ------
+
+  return YES;
+}
+
+// Handle missed call notification tap
+- (void)userNotificationCenter:(UNUserNotificationCenter *)center
+didReceiveNotificationResponse:(UNNotificationResponse *)response
+         withCompletionHandler:(void (^)())completionHandler
+{
+  NSDictionary *userInfo = response.notification.request.content.userInfo;
+  if (userInfo && [userInfo valueForKey:@"omisdkCallerNumber"]) {
+    [OmikitNotification didRecieve:userInfo];
+  }
+  completionHandler();
+}
+
+// Register push notification token
+- (void)application:(UIApplication *)app
+    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)devToken
+{
+  const unsigned char *data = (const unsigned char *)[devToken bytes];
+  NSMutableString *token = [NSMutableString string];
+  for (NSUInteger i = 0; i < [devToken length]; i++) {
+    [token appendFormat:@"%02.2hhX", data[i]];
+  }
+  [OmiClient setUserPushNotificationToken:[token copy]];
+}
+
+// Terminate all calls when app is killed
+- (void)applicationWillTerminate:(UIApplication *)application {
+  @try {
+    [OmiClient OMICloseCall];
+  } @catch (NSException *exception) {}
+}
+
+@end
+
+@implementation ReactNativeDelegate
+
+- (NSURL *)sourceURLForBridge:(RCTBridge *)bridge
+{
+  return [self bundleURL];
+}
+
+- (NSURL *)bundleURL
+{
+#if DEBUG
+  return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index"];
+#else
+  return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];
+#endif
+}
+
+@end
+```
+
+</details>
+
+> **Note:** Replace `YourAppName` with your app's module name. For production, change `KEY_OMI_APP_ENVIROMENT_SANDBOX` to `KEY_OMI_APP_ENVIROMENT_PRODUCTION`.
+
 ### 5. New Architecture (Optional)
 
 In your `Podfile`:
@@ -253,15 +617,20 @@ In your `Podfile`:
 ENV['RN_NEW_ARCH_ENABLED'] = '1'
 ```
 
-For **full bridgeless mode**, in `AppDelegate.mm`:
+For **New Architecture with video call support**, add Fabric interop registration in `AppDelegate.mm` inside `didFinishLaunchingWithOptions`, **before** `return [super ...]`:
 
 ```objc
-- (BOOL)bridgelessEnabled
-{
-  return YES;
-}
+// Required imports at the top of AppDelegate.mm
+#import <React-RCTFabric/React/RCTComponentViewFactory.h>
+#import <React-RCTFabric/React/RCTLegacyViewManagerInteropComponentView.h>
+
+// Inside didFinishLaunchingWithOptions, before return:
+[RCTLegacyViewManagerInteropComponentView supportLegacyViewManagerWithName:@"OmiLocalCameraView"];
+[RCTLegacyViewManagerInteropComponentView supportLegacyViewManagerWithName:@"OmiRemoteCameraView"];
 ```
 
+> **Important:** Bridgeless mode is **not yet supported** for video call views. If you use New Architecture, keep bridge mode enabled (do **not** add `bridgelessEnabled` returning `YES`).
+
 Then run `cd ios && pod install`.
 
 ---
@@ -293,7 +662,7 @@ Then run `cd ios && pod install`.
    │      │      │                  │      │       │
    │      ▼      │                  │      ▼       │
    │  OMIKIT SDK │                  │  OmiKit SDK  │
-   │  (v2.6.4)   │                  │  (v1.10.34)  │
+   │  (v2.6.5)   │                  │  (v1.11.4)  │
    │      │      │                  │      │       │
    │      ▼      │                  │      ▼       │
    │  SIP Stack  │                  │  SIP Stack   │
@@ -1270,73 +1639,90 @@ PBX ──► FCM ──► App receives data message
 - Foreground service keeps the app alive during the call
 - Full-screen intent for lock screen call UI
 
-### Notification Management
+---
 
-```typescript
-// Hide the system notification without affecting SIP registration
-await hideSystemNotificationSafely();
+## Permissions
 
-// Hide notification only
-await hideSystemNotificationOnly();
+Runtime permissions must be granted before making or receiving calls. We recommend using [`react-native-permissions`](https://github.com/zoontek/react-native-permissions) for a consistent cross-platform experience.
 
-// Hide notification and unregister SIP (with reason for analytics)
-await hideSystemNotificationAndUnregister('user_dismissed');
+### Install
+
+```bash
+npm install react-native-permissions
+# iOS
+cd ios && pod install
 ```
 
----
+### Android Runtime Permissions
+
+```typescript
+import { check, request, PERMISSIONS, RESULTS, Platform } from 'react-native-permissions';
 
-## Permissions (Android)
+async function requestCallPermissions(isVideo: boolean) {
+  if (Platform.OS !== 'android') return true;
 
-Android 15+ requires explicit runtime permissions for VoIP functionality.
+  // Voice call permissions
+  const permissions = [
+    PERMISSIONS.ANDROID.RECORD_AUDIO,
+    PERMISSIONS.ANDROID.CALL_PHONE,
+    PERMISSIONS.ANDROID.POST_NOTIFICATIONS, // Android 13+
+  ];
+
+  // Video call — add camera
+  if (isVideo) {
+    permissions.push(PERMISSIONS.ANDROID.CAMERA);
+  }
+
+  const results = await Promise.all(permissions.map((p) => request(p)));
+  return results.every((r) => r === RESULTS.GRANTED);
+}
+```
 
-### Quick Setup
+### iOS Runtime Permissions
 
 ```typescript
-import {
-  checkAndRequestPermissions,
-  checkPermissionStatus,
-  requestPermissionsByCodes,
-  requestSystemAlertWindowPermission,
-  openSystemAlertSetting,
-} from 'omikit-plugin';
+import { request, PERMISSIONS, RESULTS, Platform } from 'react-native-permissions';
 
-// Check and request all permissions at once
-const granted = await checkAndRequestPermissions(isVideo);
+async function requestCallPermissions(isVideo: boolean) {
+  if (Platform.OS !== 'ios') return true;
 
-// Check current permission status
-const status = await checkPermissionStatus();
-// Returns: { microphone: boolean, camera: boolean, overlay: boolean, ... }
+  const micResult = await request(PERMISSIONS.IOS.MICROPHONE);
+  if (micResult !== RESULTS.GRANTED) return false;
+
+  if (isVideo) {
+    const camResult = await request(PERMISSIONS.IOS.CAMERA);
+    if (camResult !== RESULTS.GRANTED) return false;
+  }
+
+  return true;
+}
 ```
 
-### Handle Permission Errors from startCall
+### Overlay Permission (Android only)
+
+To show incoming call UI on lock screen, overlay permission is required:
 
 ```typescript
-const result = await startCall({ phoneNumber, isVideo: false });
-
-switch (result.status) {
-  case 450: // OmiStartCallStatus.permissionMicrophone
-    await requestPermissionsByCodes([450]);
-    break;
-  case 451: // OmiStartCallStatus.permissionCamera
-    await requestPermissionsByCodes([451]);
-    break;
-  case 452: // OmiStartCallStatus.permissionOverlay
-    await requestSystemAlertWindowPermission();
-    // or open system settings directly:
-    await openSystemAlertSetting();
-    break;
-}
+import { requestSystemAlertWindowPermission, openSystemAlertSetting } from 'omikit-plugin';
+
+// Request overlay permission
+await requestSystemAlertWindowPermission();
+
+// Or open system settings directly
+await openSystemAlertSetting();
 ```
 
-### Permission Codes
+### Permission Summary
 
-| Code | Permission | Required for |
-|------|-----------|--------------|
-| 450 | Microphone | All calls |
-| 451 | Camera | Video calls |
-| 452 | Overlay (SYSTEM_ALERT_WINDOW) | Incoming call popup on lock screen |
+| Permission | Platform | Required for |
+|-----------|----------|--------------|
+| Microphone (`RECORD_AUDIO`) | Android & iOS | All calls |
+| Camera (`CAMERA`) | Android & iOS | Video calls only |
+| Phone (`CALL_PHONE`) | Android | VoIP calls |
+| Notification (`POST_NOTIFICATIONS`) | Android 13+ | Incoming call notifications |
+| Overlay (`SYSTEM_ALERT_WINDOW`) | Android | Incoming call popup on lock screen |
 
-> **Note:** On iOS, permissions are handled via `Info.plist` and system prompts. The above functions return `true` on iOS.
+> **Note:** On iOS, microphone and camera permissions are handled via `Info.plist` descriptions and system prompts. Overlay permission is not applicable on iOS.
 
 ---
 

package/android/build.gradle

@@ -65,7 +65,7 @@ dependencies {
   // OMISDK
   implementation("androidx.work:work-runtime:2.8.1")
   implementation "androidx.security:security-crypto:1.1.0-alpha06"
-  api "io.omicrm.vihat:omi-sdk:2.6.4"
+  api "io.omicrm.vihat:omi-sdk:2.6.8"
 
   // React Native — resolved from consumer's node_modules
   implementation "com.facebook.react:react-native:+"