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

package/README.md

@@ -1,59 +1,51 @@
 # Readme
 ## Using the Expo React Native SDK
 
-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.
+The Expo React Native SDK allows you to capture certain device signals (both in Android and iOS) that will be reported back to Prelude and perform silent verification of mobile devices.
 
 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
+The Android `minSdkVersion` value in the SDK is set to 26 (Android 8.0). If your application has a lower value you may need to update it.
 
-First install the SDK dependency in your app:
+You can install the SDK dependency directly from npm:
 
 ```
 npm install @prelude.so/react-native-sdk
 ```
 
-Then, where ever in your application you want to report the device signals you can use code like this:
+You will need to have the Prelude SDK key that you generate in the Prelude dashboard for your account.
+
+***Important: When you generate the SDK key in the Prelude dashboard you will be able to copy it and you should store it somewhere secure, as the dashboard will not allow you to display the same key again.***
+
+### Gathering Device Signals
+
+**Note**: Starting with v0.3.0 of the SDK, we have removed the status event and made the `dispatchSignals` function return a promise that resolves to the dispatch identifier, simplifying its usage.
+
+To collect the device signals in your application you can use code like this:
 
 ```
 ...
-// Import the react state types
-import { useEffect, useState } from "react";
 // Import the SDK types
 import * as PreludeReactNativeSdk from '@prelude.so/react-native-sdk';
 ...
 
-// Define a state to receive status updates
-const [dispatchStatus, setDispatchStatus] = useState({ dispatchID: "", status: "" });
-
-...
-// Subscribe to the event
-useEffect(() => {
-    const subscription = PreludeReactNativeSdk.onDispatchingSignals((dispatchingSignalsStatus) => {
-      console.log("Dispatch status: " + dispatchingSignalsStatus.status + ". Id: " + dispatchingSignalsStatus.dispatchID);
-      setDispatchStatus(dispatchingSignalsStatus);
-    });
-
-    return () => {
-      subscription.remove();
-    }
-  }, [dispatchStatus]);
-
 ...
 // Submit the signals in any of your app event handlers (here is a button example)
-<Button title={`Dispatch Signals`} onPress={() =>
-  PreludeReactNativeSdk.dispatchSignals({
-      sdk_key: "YOUR-SDK-KEY"
-    })
-    .catch((error) => {
-        console.log("Dispatch error: " + error);
-    })
-} />
+<Button title={`Dispatch Signals`} onPress={ async () =>
+  {
+    try {
+        const dispatchId = await PreludeReactNativeSdk.dispatchSignals({
+          sdk_key: "YOUR_SDK_KEY", // Replace with your Prelude SDK key
+        });
+
+        // Handle the dispatch ID as needed,
+        // e.g., store it or continue with verification here
+        alert(`Dispatch ID: ${dispatchId}`);
+    } catch (error) {
+        alert(`Signals dispatch error: ${error.message}`);
+    }
+  }}
+/>
 
 ```
 
@@ -69,41 +61,16 @@ or
 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.
+Once you get the dispatch identifier 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.
 
-### Silent Verification
+The recommended way of integrating it is to call the `dispatchSignals` function before displaying the phone number verification screen in your application. This way you can ensure that the device signals are captured and the `dispatchID` can be sent to your back-end with the phone number. Your back-end will then perform the verification call to Prelude with the phone number and the dispatch identifier.
 
-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.
+### Silent Verification
 
-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.
+The Silent Verification feature allows you to verify a phone number without requiring the user to manually enter a verification code.
 
-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.
+It is available for certain carriers and requires a server-side service to handle the verification process. For this verification method to work properly, you *must* collect the device signals mentioned before and report the dispatch identifier to your back-end (usually in your APIs verification endpoint).
 
-```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
-```
+Please refer to the [Silent Verification documentation](https://docs.prelude.so/verify/silent/overview) for more information on how to implement this feature.

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

@@ -5,7 +5,6 @@ import expo.modules.kotlin.modules.Module
 import expo.modules.kotlin.modules.ModuleDefinition
 import so.prelude.android.sdk.Configuration
 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
@@ -14,9 +13,7 @@ class PreludeReactNativeSdkModule : Module() {
     override fun definition() = ModuleDefinition {
         Name("PreludeReactNativeSdk")
 
-        Events("onDispatchingSignals")
-
-        AsyncFunction("dispatchSignals") { sdkKey: String, endpointUrl: String?, timeoutMilliseconds: Long? ->
+        AsyncFunction("dispatchSignals") Coroutine { sdkKey: String, endpointUrl: String?, timeoutMilliseconds: Long? ->
             dispatchSignals(endpointUrl, sdkKey, timeoutMilliseconds)
         }
 
@@ -28,47 +25,39 @@ class PreludeReactNativeSdkModule : Module() {
         }
     }
 
-    private fun dispatchSignals(
+    private suspend fun dispatchSignals(
         endpointUrl: String?,
         sdkKey: String,
         timeoutMilliseconds: Long?
-    ): String? {
+    ): 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
-                )
+            ?: throw IllegalStateException(
+                "Invalid React Android Context. Cannot dispatch signals"
             )
-                .dispatchSignals { status: DispatchStatusListener.Status, dispatchId ->
-                    sendEvent(
-                        "onDispatchingSignals", mapOf(
-                            "status" to status,
-                            "dispatchID" to dispatchId
-                        )
-                    )
-                }
-        }
+
+        val config = Configuration(
+            context.applicationContext,
+            sdkKey,
+            endpoint,
+            requestTimeout = timeoutMilliseconds ?: DEFAULT_REQUEST_TIMEOUT
+        )
+        val prelude = Prelude(config)
+                
+        return prelude.dispatchSignals().getOrThrow()
     }
 
     private suspend fun verifySilent(
         sdkKey: String,
         requestUrl: String,
-    ): String? {
+    ): String {
         val context = appContext.reactContext
-
-        if (context == null) {
-            throw IllegalStateException(
+            ?: 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.")
@@ -76,6 +65,6 @@ class PreludeReactNativeSdkModule : Module() {
 
         val prelude = Prelude(context.applicationContext, sdkKey)
 
-        return prelude.verifySilent(URL(requestUrl)).getOrNull()
+        return prelude.verifySilent(URL(requestUrl)).getOrThrow()
     }
 }

package/build/index.d.ts

@@ -1,13 +1,10 @@
-import { EventSubscription } from 'expo-modules-core';
-import { DispatchingSignalsStatus } from './PreludeReactNativeSdk.types';
 export declare function dispatchSignals(configuration: {
     sdk_key: string;
     endpoint?: string;
-}): Promise<void>;
-export declare function onDispatchingSignals(listener: (event: DispatchingSignalsStatus) => void): EventSubscription;
+    timeout_milliseconds?: number;
+}): Promise<string>;
 export declare function verifySilent(configuration: {
     sdk_key: string;
     request_url: string;
-}): Promise<String>;
-export { DispatchingSignalsStatus };
+}): Promise<string>;
 //# 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,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,wBAAsB,eAAe,CACnC,aAAa,EAAE;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,GAAG,OAAO,CAAC,MAAM,CAAC,CAEpB;AAED,wBAAsB,YAAY,CAAC,aAAa,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAE3G"}

package/build/index.js

@@ -1,9 +1,6 @@
 import PreludeReactNativeSdkModule from './PreludeReactNativeSdkModule';
 export async function dispatchSignals(configuration) {
-    return await PreludeReactNativeSdkModule.dispatchSignals(configuration.sdk_key, configuration.endpoint);
-}
-export function onDispatchingSignals(listener) {
-    return PreludeReactNativeSdkModule.addListener('onDispatchingSignals', listener);
+    return await PreludeReactNativeSdkModule.dispatchSignals(configuration.sdk_key, configuration.endpoint, configuration.timeout_milliseconds);
 }
 export async function verifySilent(configuration) {
     return await PreludeReactNativeSdkModule.verifySilent(configuration.sdk_key, configuration.request_url);

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;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"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,MAAM,+BAA+B,CAAC;AAExE,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,aAIC;IACD,OAAO,MAAM,2BAA2B,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAC9I,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 PreludeReactNativeSdkModule from './PreludeReactNativeSdkModule';\n\nexport async function dispatchSignals(\n  configuration: {\n    sdk_key: string;\n    endpoint?: string;\n    timeout_milliseconds?: number;\n  }): Promise<string> {\n  return await PreludeReactNativeSdkModule.dispatchSignals(configuration.sdk_key, configuration.endpoint, configuration.timeout_milliseconds);\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"]}

package/ios/PreludeReactNativeSdkModule.swift

@@ -4,24 +4,19 @@ public class PreludeReactNativeSdkModule: Module {
   public func definition() -> ModuleDefinition {
     Name("PreludeReactNativeSdk")
 
-    Events("onDispatchingSignals")
-
-    AsyncFunction("dispatchSignals") { (sdkKey: String, endpointUrl: String?) in
+    AsyncFunction("dispatchSignals") { (sdkKey: String, endpointUrl: String?, timeoutMilliseconds: Int64?) in
         let endpoint = endpointUrl != nil ? Endpoint.custom(endpointUrl!) : .default
+        let timeout = timeoutMilliseconds != nil ? TimeInterval(timeoutMilliseconds!) / 1000 : 2.0
         
         let configuration = Configuration(
             sdkKey: sdkKey,
-            endpoint: endpoint
+            endpoint: endpoint,
+            timeout: timeout
         )
 
         let prelude = Prelude(configuration)
 
-        do {
-            let dispatchID = try await prelude.dispatchSignals()
-            self.sendEvent("onDispatchingSignals", ["status": "SUCCESS", "dispatchID": dispatchID])
-        } catch {
-            self.sendEvent("onDispatchingSignals", ["status": "FAILURE", "dispatchID": error.localizedDescription])
-        }
+        return try await prelude.dispatchSignals()
     }
       
     AsyncFunction("verifySilent") { (sdkKey: String, requestUrl: String) in

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prelude.so/react-native-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Prelude SDK for React Native",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -41,10 +41,10 @@
   "homepage": "https://github.com/prelude-so/react-native-sdk#readme",
   "dependencies": {},
   "devDependencies": {
-    "@types/react": "~18.3.12",
+    "@types/react": "^18.3.0",
     "expo": "~52.0.46",
     "expo-module-scripts": "^4.0.2",
-    "react": "18.3.12",
+    "react": "^18.3.0",
     "react-native": "0.76.9"
   },
   "peerDependencies": {

package/src/index.ts

@@ -1,18 +1,14 @@
-import { EventSubscription } from 'expo-modules-core';
-
 import PreludeReactNativeSdkModule from './PreludeReactNativeSdkModule';
-import { DispatchingSignalsStatus } from './PreludeReactNativeSdk.types';
-
-export async function dispatchSignals(configuration: { sdk_key: string, endpoint?: string }): Promise<void> {
-  return await PreludeReactNativeSdkModule.dispatchSignals(configuration.sdk_key, configuration.endpoint);
-}
 
-export function onDispatchingSignals(listener: (event: DispatchingSignalsStatus) => void): EventSubscription {
-  return PreludeReactNativeSdkModule.addListener('onDispatchingSignals', listener);
+export async function dispatchSignals(
+  configuration: {
+    sdk_key: string;
+    endpoint?: string;
+    timeout_milliseconds?: number;
+  }): Promise<string> {
+  return await PreludeReactNativeSdkModule.dispatchSignals(configuration.sdk_key, configuration.endpoint, configuration.timeout_milliseconds);
 }
 
-export async function verifySilent(configuration: { sdk_key: string, request_url: string }): Promise<String> {
+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 };

package/build/PreludeReactNativeSdk.types.d.ts

@@ -1,10 +0,0 @@
-export type DispatchingSignalsStatus = {
-    status: string;
-    dispatchID: string;
-};
-export type Configuration = {
-    sdk_key: string;
-    endpoint?: string;
-    timeout_milliseconds?: number;
-};
-//# sourceMappingURL=PreludeReactNativeSdk.types.d.ts.map

package/build/PreludeReactNativeSdk.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PreludeReactNativeSdk.types.d.ts","sourceRoot":"","sources":["../src/PreludeReactNativeSdk.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAA"}

package/build/PreludeReactNativeSdk.types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=PreludeReactNativeSdk.types.js.map

package/build/PreludeReactNativeSdk.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PreludeReactNativeSdk.types.js","sourceRoot":"","sources":["../src/PreludeReactNativeSdk.types.ts"],"names":[],"mappings":"","sourcesContent":["export type DispatchingSignalsStatus = {\n  status: string,\n  dispatchID: string;\n};\n\nexport type Configuration = {\n  sdk_key: string;\n  endpoint?: string;\n  timeout_milliseconds?: number;\n}"]}

package/src/PreludeReactNativeSdk.types.ts

@@ -1,10 +0,0 @@
-export type DispatchingSignalsStatus = {
-  status: string,
-  dispatchID: string;
-};
-
-export type Configuration = {
-  sdk_key: string;
-  endpoint?: string;
-  timeout_milliseconds?: number;
-}