@prelude.so/react-native-sdk 0.1.1 → 0.2.0

package/README.md

@@ -1,13 +1,16 @@
 # Readme
-### Using the Expo React Native SDK
+## Using the Expo React Native SDK
 
-The Expo React Native SDK allows you to capture certain device signals (both in Android and iOS) that will be reported back to Prelude.
+The Expo React Native SDK allows you to gather device signals and perform silent verification of mobile devices.
+
+### Gathering Device Signals
+The SDK allows you to capture certain device signals (both in Android and iOS) that will be reported back to Prelude.
 
 It is provided as an Expo module that you can integrate into your React Native Expo Application.
 
 The Android `minSdkVersion` value in the SDK is set to 26 (Android 8.0). If you application has a lower value you may need to update it.
 
-## Configuring the project
+#### Configuring the project
 
 First install the SDK dependency in your app:
 
@@ -68,4 +71,39 @@ npx expo run:android
 
 Once you get the dispatch ID through the event, you can report it back to your own API to be forwarded in subsequent network calls.
 
-There is no restriction on when to call this API, you just need to take this action before you need to report back the dispatch ID. It is advisable to make the request early on during the user onboarding process to have the dispatch id available when required.
+There is no restriction on when to call this API, you just need to take this action before you need to report back the dispatch ID. It is advisable to make the request early on during the user onboarding process to have the dispatch id available when required.
+
+### Silent Verification
+
+The Silent Verification feature allows you to verify a phone number without requiring the user to enter a verification code. It is available for certain carriers and requires a server-side service to handle the verification process.
+
+The SDK provides a simple API to initiate the verification process and handle the response.
+
+We assume here that you have a server-side service that exposes the 2 endpoints, one to start the verification and another to check the final code. In this sample code we expose those endpoints via an `Api` module that will call each endpoint via a separate function.
+
+When calling the verification API, you will need to provide the phone number to verify. The API will return a request URL that the SDK will navigate to in order to complete the verification process.
+
+```typescript
+// Import the SDK types and your API module
+import * as PreludeReactNativeSdk from '@prelude.so/react-native-sdk';
+import * as Api from './YourBackendApi';
+
+// Call the verification endpoint with the phone number.
+// If the phone number is compatible with the Silent Verification feature, 
+// the API will return a request URL that the SDK will navigate to.
+const request_url = await Api.verify(phone_number);
+
+// Then call the verifySilent method with the SDK key and the request URL.
+// If the verification is successful, the SDK will return a code that you 
+// can use to check the verification status.
+var code = await PreludeReactNativeSdk.verifySilent({
+    sdk_key: sdk_key,
+    request_url: request_url,
+});
+
+// Finally, call the checkSilent method with the phone number and the code
+// Your API should handle the check and return the verification status.
+const check_status = await Api.check(phone_number, code);
+
+// Handle the verification status as needed in your application
+```

package/android/build.gradle

@@ -1,7 +1,7 @@
 apply plugin: 'com.android.library'
 
 group = 'so.prelude.reactnative.sdk'
-version = '0.1.0'
+version = '0.2.0'
 
 def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
 apply from: expoModulesCorePlugin
@@ -35,7 +35,7 @@ android {
   namespace "so.prelude.reactnative.sdk"
   defaultConfig {
     versionCode 1
-    versionName "0.1.0"
+    versionName "0.2.0"
   }
   lintOptions {
     abortOnError false
@@ -43,5 +43,5 @@ android {
 }
 
 dependencies {
-  implementation('so.prelude.android:sdk:0.1.0')
+  implementation('so.prelude.android:sdk:0.2.0')
 }

package/android/src/main/java/so/prelude/reactnative/sdk/PreludeReactNativeSdkModule.kt

@@ -1,5 +1,6 @@
 package so.prelude.reactnative.sdk
 
+import expo.modules.kotlin.functions.Coroutine
 import expo.modules.kotlin.modules.Module
 import expo.modules.kotlin.modules.ModuleDefinition
 import so.prelude.android.sdk.Configuration
@@ -7,6 +8,7 @@ import so.prelude.android.sdk.Configuration.Companion.DEFAULT_REQUEST_TIMEOUT
 import so.prelude.android.sdk.DispatchStatusListener
 import so.prelude.android.sdk.Endpoint
 import so.prelude.android.sdk.Prelude
+import java.net.URL
 
 class PreludeReactNativeSdkModule : Module() {
     override fun definition() = ModuleDefinition {
@@ -15,30 +17,65 @@ class PreludeReactNativeSdkModule : Module() {
         Events("onDispatchingSignals")
 
         AsyncFunction("dispatchSignals") { sdkKey: String, endpointUrl: String?, timeoutMilliseconds: Long? ->
+            dispatchSignals(endpointUrl, sdkKey, timeoutMilliseconds)
+        }
 
-            val endpoint: Endpoint = endpointUrl?.let {
-                Endpoint.Custom(it)
-            } ?: Endpoint.Default
-
-            val context = appContext.reactContext
-            context?.let {
-                Prelude(
-                    Configuration(
-                        it.applicationContext,
-                        sdkKey,
-                        endpoint,
-                        requestTimeout = timeoutMilliseconds ?: DEFAULT_REQUEST_TIMEOUT
-                    )
+        AsyncFunction("verifySilent") Coroutine { sdkKey: String, requestUrl: String ->
+            verifySilent(
+                sdkKey = sdkKey,
+                requestUrl = requestUrl
+            )
+        }
+    }
+
+    private fun dispatchSignals(
+        endpointUrl: String?,
+        sdkKey: String,
+        timeoutMilliseconds: Long?
+    ): String? {
+        val endpoint: Endpoint = endpointUrl?.let {
+            Endpoint.Custom(it)
+        } ?: Endpoint.Default
+
+        val context = appContext.reactContext
+        return context?.let {
+            Prelude(
+                Configuration(
+                    it.applicationContext,
+                    sdkKey,
+                    endpoint,
+                    requestTimeout = timeoutMilliseconds ?: DEFAULT_REQUEST_TIMEOUT
                 )
-                    .dispatchSignals { status: DispatchStatusListener.Status, dispatchId ->
-                        sendEvent(
-                            "onDispatchingSignals", mapOf(
-                                "status" to status,
-                                "dispatchID" to dispatchId
-                            )
+            )
+                .dispatchSignals { status: DispatchStatusListener.Status, dispatchId ->
+                    sendEvent(
+                        "onDispatchingSignals", mapOf(
+                            "status" to status,
+                            "dispatchID" to dispatchId
                         )
-                    }
-            }
+                    )
+                }
         }
     }
+
+    private suspend fun verifySilent(
+        sdkKey: String,
+        requestUrl: String,
+    ): String? {
+        val context = appContext.reactContext
+
+        if (context == null) {
+            throw IllegalStateException(
+                "Invalid React Android Context. Cannot perform silent verification"
+            )
+        }
+
+        if (sdkKey.isBlank() || requestUrl.isBlank()) {
+            throw IllegalArgumentException("SDK Key and Request URL must both be provided.")
+        }
+
+        val prelude = Prelude(context.applicationContext, sdkKey)
+
+        return prelude.verifySilent(URL(requestUrl)).getOrNull()
+    }
 }

package/build/index.d.ts

@@ -5,5 +5,9 @@ export declare function dispatchSignals(configuration: {
     endpoint?: string;
 }): Promise<void>;
 export declare function onDispatchingSignals(listener: (event: DispatchingSignalsStatus) => void): EventSubscription;
+export declare function verifySilent(configuration: {
+    sdk_key: string;
+    request_url: string;
+}): Promise<String>;
 export { DispatchingSignalsStatus };
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAGtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,wBAAsB,eAAe,CAAC,aAAa,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1G;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,GAAG,iBAAiB,CAE3G;AAED,OAAO,EAAE,wBAAwB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAGtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,wBAAsB,eAAe,CAAC,aAAa,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1G;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,GAAG,iBAAiB,CAE3G;AAED,wBAAsB,YAAY,CAAC,aAAa,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAE3G;AAED,OAAO,EAAE,wBAAwB,EAAE,CAAC"}

package/build/index.js

@@ -5,4 +5,7 @@ export async function dispatchSignals(configuration) {
 export function onDispatchingSignals(listener) {
     return PreludeReactNativeSdkModule.addListener('onDispatchingSignals', listener);
 }
+export async function verifySilent(configuration) {
+    return await PreludeReactNativeSdkModule.verifySilent(configuration.sdk_key, configuration.request_url);
+}
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,2BAA2B,MAAM,+BAA+B,CAAC;AAGxE,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,aAAqD;IACzF,OAAO,MAAM,2BAA2B,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;AAC1G,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAmD;IACtF,OAAO,2BAA2B,CAAC,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;AACnF,CAAC","sourcesContent":["import { EventSubscription } from 'expo-modules-core';\n\nimport PreludeReactNativeSdkModule from './PreludeReactNativeSdkModule';\nimport { DispatchingSignalsStatus } from './PreludeReactNativeSdk.types';\n\nexport async function dispatchSignals(configuration: { sdk_key: string, endpoint?: string }): Promise<void> {\n  return await PreludeReactNativeSdkModule.dispatchSignals(configuration.sdk_key, configuration.endpoint);\n}\n\nexport function onDispatchingSignals(listener: (event: DispatchingSignalsStatus) => void): EventSubscription {\n  return PreludeReactNativeSdkModule.addListener('onDispatchingSignals', listener);\n}\n\nexport { DispatchingSignalsStatus };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,2BAA2B,MAAM,+BAA+B,CAAC;AAGxE,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,aAAqD;IACzF,OAAO,MAAM,2BAA2B,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;AAC1G,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAmD;IACtF,OAAO,2BAA2B,CAAC,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;AACnF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,aAAuD;IACxF,OAAO,MAAM,2BAA2B,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;AAC1G,CAAC","sourcesContent":["import { EventSubscription } from 'expo-modules-core';\n\nimport PreludeReactNativeSdkModule from './PreludeReactNativeSdkModule';\nimport { DispatchingSignalsStatus } from './PreludeReactNativeSdk.types';\n\nexport async function dispatchSignals(configuration: { sdk_key: string, endpoint?: string }): Promise<void> {\n  return await PreludeReactNativeSdkModule.dispatchSignals(configuration.sdk_key, configuration.endpoint);\n}\n\nexport function onDispatchingSignals(listener: (event: DispatchingSignalsStatus) => void): EventSubscription {\n  return PreludeReactNativeSdkModule.addListener('onDispatchingSignals', listener);\n}\n\nexport async function verifySilent(configuration: { sdk_key: string, request_url: string }): Promise<String> {\n  return await PreludeReactNativeSdkModule.verifySilent(configuration.sdk_key, configuration.request_url);\n}\n\nexport { DispatchingSignalsStatus };\n"]}

package/ios/PreludeReactNativeSdkModule.swift

@@ -6,7 +6,7 @@ public class PreludeReactNativeSdkModule: Module {
 
     Events("onDispatchingSignals")
 
-      AsyncFunction("dispatchSignals") { (sdkKey: String, endpointUrl: String?) in
+    AsyncFunction("dispatchSignals") { (sdkKey: String, endpointUrl: String?) in
         let endpoint = endpointUrl != nil ? Endpoint.custom(endpointUrl!) : .default
         
         let configuration = Configuration(
@@ -23,5 +23,29 @@ public class PreludeReactNativeSdkModule: Module {
             self.sendEvent("onDispatchingSignals", ["status": "FAILURE", "dispatchID": error.localizedDescription])
         }
     }
+      
+    AsyncFunction("verifySilent") { (sdkKey: String, requestUrl: String) in
+        if sdkKey.isEmpty || requestUrl.isEmpty {
+            throw Exception(name: "IllegalArguments",
+                      description: "SDK Key and Request URL must both be provided.",
+                      code: "ILLEGAL_ARGUMENTS_EMPTY_FIELD"
+            )
+        }
+        
+        let configuration = Configuration(
+            sdkKey: sdkKey,
+        )
+
+        let prelude = Prelude(configuration)
+
+        guard let url = URL(string: requestUrl) else {
+            throw Exception(name: "IllegalArguments",
+                      description: "Request URL must be a valid URL.",
+                      code: "ILLEGAL_ARGUMENTS_INVALID_URL"
+            )
+        }
+        
+        return try await prelude.verifySilent(url: url)
+    }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prelude.so/react-native-sdk",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Prelude SDK for React Native",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -12,7 +12,9 @@
     "prepare": "expo-module prepare",
     "prepublishOnly": "expo-module prepublishOnly",
     "expo-module": "expo-module",
-    "postinstall": "node scripts/postinstall.js"
+    "postinstall": "node scripts/postinstall.js",
+    "android": "expo run:android",
+    "ios": "expo run:ios"
   },
   "keywords": [
     "react-native",
@@ -24,7 +26,7 @@
     "android/build.gradle",
     "android/src/*",
     "build/*",
-    "ios/*",
+    "ios/Prelude*",
     "scripts/*",
     "src/*",
     "expo-module.config.json",
@@ -40,9 +42,10 @@
   "dependencies": {},
   "devDependencies": {
     "@types/react": "~18.3.12",
+    "expo": "~52.0.46",
     "expo-module-scripts": "^4.0.2",
-    "expo": "~52.0.9",
-    "react-native": "0.76.2"
+    "react": "18.3.12",
+    "react-native": "0.76.9"
   },
   "peerDependencies": {
     "expo": "*",
@@ -50,6 +53,6 @@
     "react-native": "*"
   },
   "so_prelude": {
-    "apple_sdk_tag": "0.1.1"
+    "apple_sdk_tag": "0.2.1"
   }
 }

package/src/index.ts

@@ -11,4 +11,8 @@ export function onDispatchingSignals(listener: (event: DispatchingSignalsStatus)
   return PreludeReactNativeSdkModule.addListener('onDispatchingSignals', listener);
 }
 
+export async function verifySilent(configuration: { sdk_key: string, request_url: string }): Promise<String> {
+  return await PreludeReactNativeSdkModule.verifySilent(configuration.sdk_key, configuration.request_url);
+}
+
 export { DispatchingSignalsStatus };