react-native-shield-fraud-plugin 1.0.10 → 2.0.0

package/android/build.gradle

@@ -15,9 +15,6 @@ def isNewArchitectureEnabled() {
 
 apply plugin: "com.android.library"
 
-
-def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
-
 if (isNewArchitectureEnabled()) {
   apply plugin: "com.facebook.react"
 }
@@ -33,11 +30,17 @@ def getExtOrIntegerDefault(name) {
 android {
   compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
 
+  // Conditional for compatibility with AGP <4.2.
+  if (project.android.hasProperty("namespace")) {
+    namespace 'com.shieldfraudplugin'
+  }
+
   defaultConfig {
     minSdkVersion getExtOrIntegerDefault("minSdkVersion")
     targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
     buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
   }
+
   buildTypes {
     release {
       minifyEnabled false
@@ -53,6 +56,18 @@ android {
     targetCompatibility JavaVersion.VERSION_1_8
   }
 
+  sourceSets {
+    main {
+      // Select the architecture-specific ShieldFraudPluginSpec shim at build time.
+      // - oldarch: extends ReactContextBaseJavaModule (Old Architecture / bridge)
+      // - newarch: extends the codegen-generated NativeShieldFraudPluginSpec (New Architecture)
+      if (isNewArchitectureEnabled()) {
+        java.srcDirs += ['src/newarch']
+      } else {
+        java.srcDirs += ['src/oldarch']
+      }
+    }
+  }
 
   if (isNewArchitectureEnabled()) {
     react {
@@ -65,21 +80,24 @@ android {
 
 rootProject.allprojects {
   repositories {
-  mavenCentral()
-  google()
-  maven {
-    url "https://cashshield-sdk.s3.amazonaws.com/release/"
-  }
+    mavenCentral()
+    google()
+    maven {
+      url "https://cashshield-sdk.s3.amazonaws.com/release/"
+      content {
+        includeGroup "com.shield.android"
+        includeGroup "com.shield.android.module"
+      }
+    }
   }
 }
 
-
-
 dependencies {
   // For < 0.71, this will be from the local maven repo
   // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
   //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"
-  implementation 'com.shield.android:shield-fraud:1.6.+'
-}
 
+  // Shield Fraud SDK 2.x — factory-based init, callback-based device intelligence
+  implementation 'com.shield.android:shield-fraud:2.4.0'
+}

package/android/src/main/java/com/shieldfraudplugin/ShieldFraudPluginModule.java

@@ -1,40 +1,79 @@
 package com.shieldfraudplugin;
 
-import android.app.Activity;
-import android.os.Handler;
-import android.os.Looper;
+import android.app.Application;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import com.facebook.react.bridge.Arguments;
+import com.facebook.react.bridge.Callback;
 import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.module.annotations.ReactModule;
-
-import com.facebook.react.bridge.Callback;
-import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
+
 import com.shield.android.BlockedDialog;
+import com.shield.android.DeviceIntelligence;
+import com.shield.android.Environment;
+import com.shield.android.LogLevel;
+import com.shield.android.Result;
 import com.shield.android.Shield;
-import com.shield.android.ShieldCallback;
-import com.shield.android.ShieldException;
+import com.shield.android.ShieldConfig;
+import com.shield.android.ShieldCrossPlatformHelper;
+import com.shield.android.ShieldCrossPlatformParams;
+import com.shield.android.ShieldError;
+import com.shield.android.ShieldFactory;
 
+import org.json.JSONArray;
 import org.json.JSONObject;
 
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.Map;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
+/**
+ * ShieldFraudPlugin native module — Shield SDK 2.x (pure Java)
+ *
+ * SDK 2.x migration summary
+ * ─────────────────────────
+ * 1. Initialisation     : Shield.Builder  →  ShieldConfig + ShieldFactory
+ * 2. Instance access    : Shield.getInstance()  →  stored `shield` member
+ * 3. Session ID         : Shield.getInstance().getSessionId()  →  shield.getSessionId()
+ * 4. Device results     : setDeviceResultStateListener(callback)
+ *                           →  ShieldFactory.createShieldWithCallback (SHIELD Sentinel)
+ * 5. sendAttributes     : void return
+ *                           →  shield.sendAttributesWithCallback (Result<String> callback)
+ * 6. LogLevel enum      : Shield.LogLevel.VERBOSE/DEBUG/INFO/NONE
+ *                           →  LogLevel.DEBUG / INFO / NONE  (VERBOSE removed)
+ * 7. Environment enum   : String constants ENVIRONMENT_PROD / DEV / STAGING
+ *                           →  Environment.PROD / DEV  (STAGING removed)
+ *
+ * Architecture segmentation
+ * ─────────────────────────
+ * Handled by Gradle source sets (not #ifdef).
+ *   src/oldarch/ShieldFraudPluginSpec.java  →  extends ReactContextBaseJavaModule
+ *   src/newarch/ShieldFraudPluginSpec.java  →  extends NativeShieldFraudPluginSpec (codegen)
+ * This module always extends ShieldFraudPluginSpec.
+ */
 @ReactModule(name = ShieldFraudPluginModule.NAME)
-public class ShieldFraudPluginModule extends ReactContextBaseJavaModule implements ShieldCallback<JSONObject> {
+public class ShieldFraudPluginModule extends com.shieldfraudplugin.ShieldFraudPluginSpec {
+
     public static final String NAME = "ShieldFraudPlugin";
+
     private final ReactApplicationContext reactContext;
 
+    /**
+     * Stored Shield instance — created once by ShieldFactory in initShield().
+     * All subsequent calls use this reference instead of a singleton accessor.
+     */
+    @Nullable
+    private Shield shield = null;
+
+
     public ShieldFraudPluginModule(ReactApplicationContext reactContext) {
         super(reactContext);
         this.reactContext = reactContext;
@@ -46,158 +85,350 @@ public class ShieldFraudPluginModule extends ReactContextBaseJavaModule implemen
         return NAME;
     }
 
+    // =========================================================================
+    // Synchronous state queries
+    // =========================================================================
+
     @ReactMethod(isBlockingSynchronousMethod = true)
     public boolean isShieldInitialized() {
-        try {
-            return Shield.getInstance() != null;
-        } catch (IllegalStateException e) {
-            return false;
-        }
+        return shield != null;
+    }
+
+    @ReactMethod(isBlockingSynchronousMethod = true)
+    public String getSessionId() {
+        return shield != null ? shield.getSessionId() : "";
     }
 
+    // =========================================================================
+    // SDK initialisation  (Shield SDK 2.x — ShieldConfig + ShieldFactory)
+    //
+    // createShieldWithCallback both initialises the SDK and acts as the
+    // SHIELD Sentinel callback — it fires on the initial fingerprint and on
+    // every subsequent device intelligence update during the session.
+    //
+    // logLevel / environmentInfo arrive as `double` from both architectures:
+    //   • Old Arch — JS bridge maps JS numbers to double.
+    //   • New Arch — codegen generates double for TypeScript number params.
+    // =========================================================================
+
     @ReactMethod
-    public void initShield(String siteID, String secretKey, Boolean isOptimizedListener, ReadableMap blockedDialog, Integer logLevel, Integer environment) {
+    public void initShield(
+            String siteID,
+            String secretKey,
+            boolean isOptimizedListener,
+            @Nullable ReadableMap blockedDialog,
+            double logLevel,
+            double environmentInfo,
+            boolean blockScreenRecording,
+            Promise promise) {
+
         if (isShieldInitialized()) {
+            promise.resolve(null);
             return;
         }
-        Activity currentActivity = getCurrentActivity();
-        if (currentActivity != null) {
-            Shield.Builder builder = new Shield.Builder(currentActivity, siteID, secretKey)
-                    .setAutoBlockDialog(getBlockedDialogFromReadableMap(blockedDialog));
 
-            if (isOptimizedListener) {
-                builder.registerDeviceShieldCallback(this);
-            }
+        Application application = (Application) reactContext.getApplicationContext();
+
+        ShieldConfig config = new ShieldConfig(siteID, secretKey);
+        config.setLogLevel(getLogLevelFromInt((int) logLevel));
+        config.setEnvironment(getEnvironmentFromInt((int) environmentInfo));
 
-            String environmentString = getEnvironmentStringFromInteger(environment);
-            builder.setEnvironment(environmentString);
+        if (blockedDialog != null) {
+            String title = blockedDialog.hasKey("title") ? blockedDialog.getString("title") : null;
+            String body  = blockedDialog.hasKey("body")  ? blockedDialog.getString("body")  : null;
+            config.setBlockedDialog(new BlockedDialog(title, body));
+        }
 
-            Shield.LogLevel logLevelEnum = getLogLevelEnumFromInteger(logLevel);
-            builder.setLogLevel(logLevelEnum);
+        // blockScreenRecording is Android-only. JS always sends a real boolean
+        // (true/false, never null) so the Old Arch bridge can safely read it as
+        // a primitive. Defaults to false when the user doesn't set it in Config.
+        config.setBlockScreenRecording(blockScreenRecording);
 
-            Shield shield = builder.build();
-            Shield.setSingletonInstance(shield);
+        if (isOptimizedListener) {
+            // SDK 2.x: createShieldWithCallback initialises + acts as the Sentinel.
+            // Unlike 1.x (which required a separate setDeviceResultStateListener() call
+            // on the SDK), 2.x fires this callback automatically when device intelligence
+            // is ready and on every subsequent risk-profile change.
+            // The callback may arrive on a background thread — always post to main looper.
+            shield = ShieldFactory.createShieldWithCallback(
+                    application,
+                    config,
+                    result -> new android.os.Handler(android.os.Looper.getMainLooper()).post(() -> {
+                        if (result instanceof Result.Success) {
+                            DeviceIntelligence di =
+                                    ((Result.Success<DeviceIntelligence>) result).getData();
+                            JSONObject json = di != null ? di.getData() : null;
+                            emitEvent("success", json != null ? json.toString() : null);
+                        } else if (result instanceof Result.Failure) {
+                            ShieldError error =
+                                    ((Result.Failure<DeviceIntelligence>) result).getError();
+                            emitEvent("error", error.getErrorMessage());
+                        }
+                    }));
+        } else {
+            // createShield = initialise without the real-time Sentinel callback.
+            // Use getLatestDeviceResult() to poll on demand instead.
+            shield = ShieldFactory.createShield(application, config);
         }
+
+        promise.resolve(null);
     }
 
-    private BlockedDialog getBlockedDialogFromReadableMap(ReadableMap blockedDialog) {
-        if (blockedDialog != null) {
-            String title = blockedDialog.hasKey("title") ? blockedDialog.getString("title") : null;
-            String body = blockedDialog.hasKey("body") ? blockedDialog.getString("body") : null;
-            return new BlockedDialog(title, body);
-        }
-        return null;
+    // =========================================================================
+    // Cross-platform metadata
+    // =========================================================================
+
+    @ReactMethod
+    public void setCrossPlatformParameters(String crossPlatformName, String crossPlatformVersion) {
+        ShieldCrossPlatformParams params =
+                new ShieldCrossPlatformParams(crossPlatformName, crossPlatformVersion);
+        ShieldCrossPlatformHelper.setCrossPlatformParameters(params);
     }
 
-    private String getEnvironmentStringFromInteger(Integer environment) {
-        String environmentString;
-        switch (environment) {
-            case 1:
-                environmentString = Shield.ENVIRONMENT_DEV;
-                break;
-            case 2:
-                environmentString = Shield.ENVIRONMENT_STAGING;
-                break;
-            default:
-                environmentString = Shield.ENVIRONMENT_PROD;
-                break;
-        }
-        return environmentString;
+    // =========================================================================
+    // setDeviceResultStateListener — no-op stub (SDK 2.x)
+    //
+    // SDK 1.x required a manual subscription call + Handler.postDelayed workaround.
+    // SDK 2.x fires device result events automatically via createShieldWithCallback
+    // when isOptimizedListener == true — no subscription call needed.
+    //
+    // The method is kept as a no-op stub so the shared TypeScript codegen spec
+    // and iOS (which still calls the SDK method) remain unaffected.
+    // =========================================================================
+
+    @ReactMethod
+    public void setDeviceResultStateListener() {
+        // No-op on Android SDK 2.x — device result events are delivered
+        // automatically through the createShieldWithCallback Sentinel.
     }
 
-    private Shield.LogLevel getLogLevelEnumFromInteger(Integer logLevel) {
-        Shield.LogLevel logLevelEnum;
-        switch (logLevel) {
-            case 1:
-                logLevelEnum = Shield.LogLevel.NONE;
-                break;
-            case 2:
-                logLevelEnum = Shield.LogLevel.INFO;
-                break;
-            case 3:
-                logLevelEnum = Shield.LogLevel.DEBUG;
-                break;
-            default:
-                logLevelEnum = Shield.LogLevel.VERBOSE;
-                break;
+    // =========================================================================
+    // Retrieve the latest device intelligence result
+    //
+    // Returns Shield SDK's latest device result payload.
+    // =========================================================================
+
+    @ReactMethod
+    public void getLatestDeviceResult(Callback successCallback, Callback errorCallback) {
+        if (shield == null) {
+            errorCallback.invoke("Shield SDK is not initialized.");
+            return;
+        }
+
+        JSONObject json = shield.getLatestDeviceResult();
+        if (json == null) {
+            errorCallback.invoke("No device result available yet.");
+            return;
         }
-        return logLevelEnum;
+
+        successCallback.invoke(toWritableMap(json));
     }
 
+    // =========================================================================
+    // Send user / screen attributes  (Shield SDK 2.x — sendAttributesWithCallback)
+    //
+    // sendAttributesWithCallback delivers a Result<String> where the String
+    // is the sessionId on success.
+    // =========================================================================
+
     @ReactMethod
-    public void setDeviceResultStateListener() {
-        new Handler(Looper.getMainLooper()).postDelayed(new Runnable() {
-            @Override
-            public void run() {
-                Shield.getInstance().setDeviceResultStateListener(new Shield.DeviceResultStateListener() {
-                    @Override
-                    public void isReady() {
-                        // Emit an event when the device is ready
-                        WritableMap params = Arguments.createMap();
-                        params.putString("status", "isSDKReady");
-                        reactContext
-                                .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
-                                .emit("device_result_state", params);
-                    }
-                });
+    public void sendAttributes(String screenName, ReadableMap json) {
+        if (shield == null) return;
+
+        Map<String, String> data = toStringMap(json);
+
+        shield.sendAttributesWithCallback(screenName, data, result -> {
+            if (result instanceof Result.Failure) {
+                ShieldError error = ((Result.Failure<String>) result).getError();
+                emitEvent("error", error.getErrorMessage());
             }
-        }, 1500);
+        });
     }
 
+    @ReactMethod
+    public void sendAttributesWithCallback(
+            String screenName,
+            ReadableMap json,
+            Callback successCallback,
+            Callback errorCallback) {
+        if (shield == null) {
+            errorCallback.invoke("Shield SDK is not initialized.");
+            return;
+        }
 
-    @ReactMethod(isBlockingSynchronousMethod = true)
-    public String getSessionId() {
-        return Shield.getInstance().getSessionId();
+        Map<String, String> data = toStringMap(json);
+        shield.sendAttributesWithCallback(screenName, data, result ->
+                new android.os.Handler(android.os.Looper.getMainLooper()).post(() -> {
+                    if (result instanceof Result.Success) {
+                        successCallback.invoke(true);
+                    } else if (result instanceof Result.Failure) {
+                        ShieldError error = ((Result.Failure<String>) result).getError();
+                        String errorMessage = error != null
+                                ? error.getErrorMessage()
+                                : "Failed to send attributes.";
+                        errorCallback.invoke(errorMessage);
+                    }
+                })
+        );
     }
 
-    @Override
-    public void onSuccess(@Nullable JSONObject jsonObject) {
-        if (jsonObject != null) {
-            reactContext
-                    .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
-                    .emit("success", jsonObject.toString());
+    // =========================================================================
+    // Send device signature
+    //
+    // Triggers a device signature computation for the given screen name.
+    // On success the SDK calls back with the session ID (String); the latest
+    // device result JSONObject is then retrieved via shield.getLatestDeviceResult().
+    // =========================================================================
+
+    @ReactMethod
+    public void sendDeviceSignature(
+            String screenName,
+            Callback successCallback,
+            Callback errorCallback) {
+        if (shield == null) {
+            errorCallback.invoke("Shield SDK is not initialized.");
+            return;
         }
+
+        shield.sendDeviceSignatureWithCallback(screenName, result ->
+                new android.os.Handler(android.os.Looper.getMainLooper()).post(() -> {
+                    if (result instanceof Result.Success) {
+                        JSONObject json = shield.getLatestDeviceResult();
+                        successCallback.invoke(json != null ? toWritableMap(json) : null);
+                    } else if (result instanceof Result.Failure) {
+                        ShieldError error = ((Result.Failure<String>) result).getError();
+                        errorCallback.invoke(error != null
+                                ? error.getErrorMessage()
+                                : "Failed to send device signature.");
+                    }
+                })
+        );
     }
 
+    // =========================================================================
+    // RCTEventEmitter stubs — required for compatibility on both architectures
+    // =========================================================================
+
+    @ReactMethod
+    public void addListener(String eventName) {}
+
+    @ReactMethod
+    public void removeListeners(double count) {}
+
+    // =========================================================================
+    // Module teardown
+    // =========================================================================
+
     @Override
-    public void onFailure(@Nullable ShieldException e) {
-        if (e != null) {
-            reactContext
-                    .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
-                    .emit("error", e.getLocalizedMessage());
-        }
+    public void invalidate() {
+        // Do not call super.invalidate() — ReactContextBaseJavaModule does not
+        // declare invalidate() as a concrete method in older React Native versions
+        // (it is only on the NativeModule interface), so super.invalidate() fails
+        // to compile. Our own cleanup is all that is needed here.
+        shield = null;
+    }
+
+    // =========================================================================
+    // Internal helpers
+    // =========================================================================
 
+    private void emitEvent(String eventName, Object data) {
+        reactContext
+                .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
+                .emit(eventName, data);
     }
 
-    @ReactMethod
-    public void sendAttributes(String screenName, ReadableMap json) {
-        HashMap<String, String> data = new HashMap<String, String>();
+    private Map<String, String> toStringMap(ReadableMap json) {
+        Map<String, String> data = new HashMap<>();
         for (Map.Entry<String, Object> entry : json.toHashMap().entrySet()) {
-            data.put(entry.getKey(), (String) entry.getValue());
+            if (entry.getValue() instanceof String) {
+                data.put(entry.getKey(), (String) entry.getValue());
+            }
         }
-        Shield.getInstance().sendAttributes(screenName, data);
+        return data;
     }
 
-    @ReactMethod
-    public void getLatestDeviceResult(Callback successCallback, Callback errorCallback) {
-        Shield shieldInstance = Shield.getInstance();
-        JSONObject deviceResult = shieldInstance.getLatestDeviceResult();
-    
-        if (deviceResult != null) {
-            successCallback.invoke(deviceResult.toString());
+    private WritableMap toWritableMap(JSONObject jsonObject) {
+        WritableMap map = Arguments.createMap();
+        Iterator<String> keys = jsonObject.keys();
+        while (keys.hasNext()) {
+            String key = keys.next();
+            putValueInMap(map, key, jsonObject.opt(key));
+        }
+        return map;
+    }
+
+    private WritableArray toWritableArray(JSONArray jsonArray) {
+        WritableArray array = Arguments.createArray();
+        for (int i = 0; i < jsonArray.length(); i++) {
+            pushValueInArray(array, jsonArray.opt(i));
+        }
+        return array;
+    }
+
+    private void putValueInMap(WritableMap map, String key, Object value) {
+        if (value == null || value == JSONObject.NULL) {
+            map.putNull(key);
+        } else if (value instanceof Boolean) {
+            map.putBoolean(key, (Boolean) value);
+        } else if (value instanceof Number) {
+            map.putDouble(key, ((Number) value).doubleValue());
+        } else if (value instanceof JSONObject) {
+            map.putMap(key, toWritableMap((JSONObject) value));
+        } else if (value instanceof JSONArray) {
+            map.putArray(key, toWritableArray((JSONArray) value));
         } else {
-            ShieldException error = shieldInstance.getResponseError();
-            String errorMessage = (error != null) ? error.getMessage() : "unknown error";
-            errorCallback.invoke(errorMessage);
+            map.putString(key, String.valueOf(value));
         }
-    } 
-    @ReactMethod
-    public void addListener(String eventName) {
-        // Code to handle adding listeners
     }
-    
-    @ReactMethod
-    public void removeListeners(int count) {
-        // Code to handle removing listeners
+
+    private void pushValueInArray(WritableArray array, Object value) {
+        if (value == null || value == JSONObject.NULL) {
+            array.pushNull();
+        } else if (value instanceof Boolean) {
+            array.pushBoolean((Boolean) value);
+        } else if (value instanceof Number) {
+            array.pushDouble(((Number) value).doubleValue());
+        } else if (value instanceof JSONObject) {
+            array.pushMap(toWritableMap((JSONObject) value));
+        } else if (value instanceof JSONArray) {
+            array.pushArray(toWritableArray((JSONArray) value));
+        } else {
+            array.pushString(String.valueOf(value));
+        }
+    }
+
+    /**
+     * Maps JS logLevel integer → Shield SDK LogLevel enum.
+     *
+     *  JS LogLevel enum values (src/index.tsx):
+     *    LogLevelVerbose = 4  →  LogLevel.VERBOSE
+     *    LogLevelDebug   = 3  →  LogLevel.DEBUG
+     *    LogLevelInfo    = 2  →  LogLevel.INFO
+     *    LogLevelNone    = 1  →  LogLevel.NONE   (default)
+     */
+    private LogLevel getLogLevelFromInt(int logLevel) {
+        switch (logLevel) {
+            case 4:  return LogLevel.VERBOSE;
+            case 3:  return LogLevel.DEBUG;
+            case 2:  return LogLevel.INFO;
+            default: return LogLevel.NONE;
+        }
+    }
+
+    /**
+     * Maps JS environmentInfo integer → Shield SDK Environment enum.
+     *
+     *  JS EnvironmentInfo enum values (src/index.tsx):
+     *    EnvironmentProd    = 0  →  Environment.PROD     (default)
+     *    EnvironmentDev     = 1  →  Environment.DEV
+     *    EnvironmentStaging = 2  →  Environment.STAGING
+     */
+    private Environment getEnvironmentFromInt(int environment) {
+        switch (environment) {
+            case 1:  return Environment.DEV;
+            case 2:  return Environment.STAGING;
+            default: return Environment.PROD;
+        }
     }
 }