@reclaimprotocol/inapp-rn-sdk 0.9.4-alpha.4 → 0.10.2

package/InappRnSdk.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
 
   s.source_files = "ios/**/*.{h,m,mm,cpp,swift}"
   s.private_header_files = "ios/generated/**/*.h"
-  s.dependency "ReclaimInAppSdk", "~> 0.9.2"
+  s.dependency "ReclaimInAppSdk", "~> 0.10.2"
 
   # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
   # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.

package/README.md

@@ -18,255 +18,17 @@ This SDK allows you to integrate Reclaim's in-app verification process into your
 ## Example
 
 - See the [Reclaim Example - React Native](samples/example_new_arch/README.md) for a complete example of how to use the SDK in a React Native application.
+- See the [Reclaim Example - React Native Expo](samples/example_expo/README.md) for a complete example of how to use the SDK in a React Native Expo application.
 
 ## Installation
 
-```sh
-npm install @reclaimprotocol/inapp-rn-sdk
-```
-
-Or if you're using Expo, use:
-
-```sh
-npx expo install @reclaimprotocol/inapp-rn-sdk
-```
-
-### Alternative: Install from git source
-
-#### NPM
-
-```sh
-npm install git+https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk.git
-```
-
-#### Yarn
-
-```sh
-yarn add git+https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk.git
-```
-
-## Setup
-
-### Expo Only Setup
-
-Expo users can skip the native configuration changes by adding the Reclaim InApp Config Plugin. To do so merge the following code to the plugins section of your `app.json`, `app.config.js`, or `app.config.ts` file:
-
-```diff
-{
-  // .. other plugin options (removed for brevity)
-  "plugins": [
-    "expo-router",
-    // Add the following in the plugins section:
-+   "@reclaimprotocol/inapp-rn-sdk",
-    [
-      "expo-splash-screen",
-      {
-        "image": "./assets/images/splash-icon.png",
-        "imageWidth": 200,
-        "resizeMode": "contain",
-        "backgroundColor": "#ffffff"
-      }
-    ]
-    // ... other plugins (removed for brevity)
-  ],
-  // .. other options (removed for brevity)
-}
-```
-
-Note: This module contains custom native code which is NOT supported by Expo Go
-
-If you're using Expo without EAS, run the following commands:
-
-```
-# For iOS
-npx expo prebuild
-npx expo run:ios
-
-# For Android
-npx expo prebuild
-npx expo run:android
-```
-
-If you're using Expo with EAS, create a new build:
-
-```
-# For online builds
-npx eas-cli build --profile development
-
-# For local builds
-npx eas-cli build --profile development --local
-```
-
-Follow [the fixing ios performance issues guide](#fixing-performance-issues-on-ios-physical-devices) to fix slow proof generation on iOS physicial devices.
-
-Now your expo project is ready to use. [You can follow the usage section for more](#usage).
-
-### Android Setup
-
-Add the following to your `android/app/src/main/AndroidManifest.xml` file under the `<application>` tag:
-
-```xml
-      <activity
-        android:name="org.reclaimprotocol.inapp_sdk.ReclaimActivity"
-        android:theme="@style/Theme.ReclaimInAppSdk.LaunchTheme"
-        android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
-        android:hardwareAccelerated="true"
-        android:windowSoftInputMode="adjustResize"
-        />
-```
-
-add the following to the end of settings.gradle:
-
-```groovy
-dependencyResolutionManagement {
-    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
-    String flutterStorageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
-    String reclaimStorageUrl = System.env.RECLAIM_STORAGE_BASE_URL ?: "https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo"
-    repositories {
-        google()
-        mavenCentral()
-        maven {
-            url "$reclaimStorageUrl"
-        }
-        maven {
-            url "$flutterStorageUrl/download.flutter.io"
-        }
-    }
-}
-```
-
-(Ignore if already added in settings.gradle from above)
-or alternatively add the following repositories to the relevant repositories block:
-
-```groovy
-String flutterStorageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
-String reclaimStorageUrl = System.env.RECLAIM_STORAGE_BASE_URL ?: "https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo"
-maven {
-    url "$reclaimStorageUrl"
-}
-maven {
-    url "$flutterStorageUrl/download.flutter.io"
-}
-```
-
-Some projects may require you to add the repositories to the root `build.gradle` file or your app-level `build.gradle` file's allprojects section.
-
-### iOS Setup
-
-1. Make sure to define a global platform for your project in your `Podfile` with version 13.0 or higher.
-
-```
-platform :ios, '13.0' # or platform :ios, min_ios_version_supported
-```
-
-Ignore if you already have this declaration in your `Podfile`.
+Choose the appropriate installation guide based on your project setup:
 
-2. Add the following to your `Podfile` to override SDK dependency:
+**For React Native projects without Expo:**
+📖 [Installation Guide for React Native (No Framework)](documentation/install-no-framework.md)
 
-- You can override the version of dependency when you wish to use a specific version of the SDK.
-- You can add a declaration in your `Podfile` to install the SDK from cocoapods, or from a specific git tag, head, commit, or branch.
-
-##### From cocoapods (recommended)
-
-```ruby
-# Cocoapods is the recommended way to install the SDK.
-pod 'ReclaimInAppSdk', '~> 0.9.2'
-```
-
-##### From a specific tag
-
-```ruby
-pod 'ReclaimInAppSdk', :git => 'https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk.git', :tag => '0.9.2'
-```
-
-##### From git HEAD
-
-```ruby
-pod 'ReclaimInAppSdk', :git => 'https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk.git'
-```
-
-##### From a specific commit
-
-```ruby
-pod 'ReclaimInAppSdk', :git => 'https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk.git', :commit => 'eeb5a5484a5927217065e5c988fab8201cb2db2e'
-```
-
-##### From a specific branch
-
-```ruby
-pod 'ReclaimInAppSdk', :git => 'https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk.git', :branch => 'main'
-```
-
-- After adding the dependency, your podfile may look like this:
-
-```ruby
-platform :ios, '13.0'
-
-# ... some podfile content (removed for brevity)
-
-target 'InappRnSdkExample' do
-  config = use_native_modules!
-
-  use_react_native!(
-    :path => config[:reactNativePath],
-    :app_path => "#{Pod::Config.instance.installation_root}/.."
-  )
-
-  # This is the line that you may need to add in your podfile.
-  pod 'ReclaimInAppSdk', '~> 0.9.2'
-
-  pre_install do |installer|
-    system("cd ../../ && npx bob build --target codegen")
-  end
-
-  # ... rest of the podfile. (removed for brevity)
-```
-
-3. Run `pod install` inside the `ios/` directory of your project.
-
-```sh
-cd ios/
-pod install
-```
-
-#### Fixing performance issues on IOS physical devices
-
-Your app performance will be severely impacted when you run debug executable on a physical device. Fixing this requires a simple change in your Xcode project xcscheme.
-
-##### Method 1: Update Environment Variables for XCScheme (Recommended) 
-1. Open your iOS project (*.xcworkspace) in Xcode.
-2. Click on the project target.
-3. Click on the **Scheme** dropdown.
-
-<img src="https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk/blob/83f23570a47828d011b713679852053acdba89c1/Screenshots/Install/10.png?raw=true" alt="Edit current xcscheme in Xcode" width="500">
-
-4. Click on the **Edit Scheme** button.
-5. Click on the **Run** tab.
-6. Click on the **Arguments** tab and check the **Environment Variables** section.
-
-<img src="https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk/blob/83f23570a47828d011b713679852053acdba89c1/Screenshots/Install/12.png?raw=true" alt="Enable Debug executable in Xcode" width="500">
-
-7. Add the following environment variable:
-    - Key: `GODEBUG`
-    - Value: `asyncpreemptoff=1`
-8. Click on the **Close** button in the dialog and build the project.
-9. Run the app on a physical device.
-
-##### Method 2: Disable "Debug executable"
-
-This method is **not recommended** but could be useful if you don't want to add environment variables to the xcscheme.
-
-1. Open your iOS project (*.xcworkspace) in Xcode.
-2. Click on the project target.
-3. Click on the **Scheme** dropdown.
-
-<img src="https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk/blob/83f23570a47828d011b713679852053acdba89c1/Screenshots/Install/10.png?raw=true" alt="Edit current xcscheme in Xcode" width="500">
-
-4. Click on the **Edit Scheme** button.
-5. Click on the **Run** tab.
-6. Uncheck the **Debug executable** checkbox.
-
-<img src="https://github.com/reclaimprotocol/reclaim-inapp-ios-sdk/blob/83f23570a47828d011b713679852053acdba89c1/Screenshots/Install/11.png?raw=true" alt="Enable Debug executable in Xcode" width="500">
+**For React Native Expo projects:**
+📖 [Installation Guide for React Native Expo](documentation/install-expo.md)
 
 ## Usage
 
@@ -352,12 +114,31 @@ error.innerError
 
 ## Troubleshooting
 
+### Compatibility Notice: expo-dev-client on iOS
+
+Please be aware of a known incompatibility between ReclaimInAppSdk and the [`expo-dev-client`](https://www.npmjs.com/package/expo-dev-client) package on the iOS platform.
+
+When both packages are present in your iOS application, critical network requests from ReclaimInAppSdk may fail with a request timeout error (i.e `Http failed. Checking if we can retry..\nNSErrorClientException: The request timed out.`).
+
+Our team is investigating this issue to find a solution. In the meantime, we recommend temporarily removing expo-dev-client from your project when you need to test or use ReclaimInAppSdk functionality on iOS.
+
+### iOS build issues
+
+Incase you get errors which say `CocoaPods could not find compatible versions for pod "ReclaimInAppSdk"`, run the following in your project's `ios/` directory:
+
+```sh
+bundle exec pod update ReclaimInAppSdk
+# or
+pod update ReclaimInAppSdk
+```
+
 ### Build failures for iOS in 0.7.x
 
 - An accidental breaking change may cause 0.7.0, 0.7.1, 0.7.2 to fail with build failures for Android and iOS. Update 0.7.3 fixes this issue.
 
 ## Migration
 
+- Migration steps for [0.10.2](https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/documentation/migration.md#0102)
 - Migration steps for [0.9.2](https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/documentation/migration.md#092)
 - Migration steps for [0.9.1](https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/documentation/migration.md#091)
 - Migration steps for [0.9.0](https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/documentation/migration.md#090)

package/android/build.gradle

@@ -118,7 +118,7 @@ dependencies {
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
   //noinspection UseTomlInstead
-  implementation "org.reclaimprotocol:inapp_sdk:0.9.2"
+  implementation "org.reclaimprotocol:inapp_sdk:0.10.2"
 }
 
 if (isNewArchitectureEnabled()) {

package/ios/InappRnSdk.mm

@@ -132,6 +132,24 @@ Api *api = [[Api alloc] init];
                      }];
 }
 
+- (void)startVerificationFromJson:(nonnull NSString *)templateJsonString resolve:(nonnull RCTPromiseResolveBlock)resolve reject:(nonnull RCTPromiseRejectBlock)reject {
+  NSLog(@"[InappRnSdk] starting verification");
+
+  NSLog(@"[InappRnSdk] starting verification now");
+  [api startVerificationFromJsonWithTemplate:templateJsonString
+                     completionHandler:^(
+                         NSDictionary<NSString *, id> *_Nullable result,
+                         NSError *_Nullable error) {
+                       if (error != nil) {
+                         NSLog(@"[InappRnSdk] Api Error: %@", error);
+                         reject(@"VERIFICATION_ERROR", @"Verification Error",
+                                error);
+                       } else {
+                         resolve(result);
+                       }
+                     }];
+}
+
 - (void)setOverrides:(JS::NativeInappRnSdk::Overrides &)overrides
              resolve:(nonnull RCTPromiseResolveBlock)resolve
               reject:(nonnull RCTPromiseRejectBlock)reject {

package/ios/inapp_rn_sdk/Api.swift

@@ -126,7 +126,13 @@ import ReclaimInAppSdk
   ) async throws -> [String: Any] {
     return try await startVerificationWithRequest(.url(url))
   }
-
+  
+  @objc public func startVerificationFromJson(
+    template: String
+  ) async throws -> [String: Any] {
+    return try await startVerificationWithRequest(.json(JSONUtility.fromString(template) as? [AnyHashable?: Sendable?] ?? [:]))
+  }
+  
   @objc public func setOverrides(
     provider: OverridenProviderInformation?,
     featureOptions: OverridenFeatureOptions?,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reclaimprotocol/inapp-rn-sdk",
-  "version": "0.9.4-alpha.4",
+  "version": "0.10.2",
   "description": "Reclaim Protocol's InApp React Native SDK for ZK proof generations for requests with an in-app experience of web verification",
   "source": "./src/index.ts",
   "main": "./lib/commonjs/index.js",