react-native-shield-fraud-plugin 1.0.6 → 1.0.7

package/README.md

@@ -41,13 +41,9 @@ You can refer to the Changelog to see more details about our updates.
 
 ### Initialize the SDK
 
-The SDK initialization should be configured at the earliest of the App Lifecycle to ensure successful generation and processing of the device fingerprint. SDK is to be initialised only once and will throw an exception if it is initialised more than once.
-
-
-You need both the SHIELD_SITE_ID and SHIELD_SECRET_KEY to initialize the SDK. You can locate them at the top of the page.
-
-You can initialize the SDK by calling it inside UseEffect() 
+The SDK initialization should be configured on `useEffect` *(for **Functional Components**)* or `componentDidMount` *(for **Class Components**)* in your **App.tsx** or on **App launch** to ensure successful generation and processing of the device fingerprint. The SDK is to be initialized only once and will throw an exception if it is initialized more than once.
 
+You need both the **SHIELD_SITE_ID** and **SHIELD_SECRET_KEY** to initialize the SDK. You can locate them at the top of the page.
 ```
 const config: Config = {
    siteID: 'SHIELD_SITE_ID',
@@ -55,14 +51,19 @@ const config: Config = {
 };
 
 useEffect(() => {
-    ShieldFraud.initShield(config)
-}
+  const initializeShield = async () => {
+    await ShieldFraud.initShield(config);
+  };
+  
+  initializeShield();
+}, []);
 ```
+**Note** - ```await ShieldFraud.initShield(config)``` - *The await keyword is used to wait for the promise returned by the initShield function to resolve. In React Native, It is best practice to use `await` when calling native modules from React Native, especially during `asynchronous` operations such as SDK Initialization. This is because using `await` ensures that the main thread is not blocked while the native module is initializing.*
 
 `Config` has these **optional** parameters:
 
-1. `logLevel` Set your log level to debug, info or none. | Receives high-level information about how the SDK processes network requests, responses or error information during SDK integration. Default log level is none. 
-2. `environmentInfo` Set your environment info to prod, dev or staging. Default environment info is prod.
+1. `logLevel` Set your log level to `debug`, `info` or `none`. | Receives high-level information about how the SDK processes network requests, responses or error information during SDK integration. Default log level is `none`.
+2. `environmentInfo` Set your environment info to `prod`, `dev` or `staging`. Default environment info is `prod`.
 3. `blockedDialog` Set your dialog for the blocked dialog both title and body or you can send it as null as well 
 
 Note: You can check whether Shield SDK is ready or not by using isSDKready function
@@ -107,7 +108,7 @@ You can register a callback if you would like to be notified in the event that t
 
 Add an additional parameter during intialization in order to register a callback. 
 
-For example - ShieldFraud.initShield(config, **callbacks**);
+**For example - `await ShieldFraud.initShield(config, callbacks);`**
  ```
  const callbacks: ShieldCallback = {
   onSuccess: (data) => {
@@ -125,7 +126,12 @@ const config: Config = {
   secretKey: 'SHIELD_SECRET_KEY'
 };
 
-ShieldFraud.initShield(config, callbacks);
+useEffect(() => {
+  const initializeShield = async () => {
+    await ShieldFraud.initShield(config, callbacks);
+  };
+  initializeShield();
+}, []);
  ```
 
 #### Retrieve device results via Customized Pull

package/ios/ShieldFraudPlugin.xcodeproj/project.pbxproj

@@ -8,7 +8,6 @@
 
 /* Begin PBXBuildFile section */
 		4DC15CAF29F27C9B002A8B6C /* ShieldFraudPlugin.m in Sources */ = {isa = PBXBuildFile; fileRef = B3E7B5891CC2AC0600A0062D /* ShieldFraudPlugin.m */; };
-		F167571A67B6200098CBA80C /* Pods_ShieldFraudPlugin.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = F046944AE9395EF1AEB8DB39 /* Pods_ShieldFraudPlugin.framework */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXCopyFilesBuildPhase section */
@@ -25,11 +24,8 @@
 
 /* Begin PBXFileReference section */
 		134814201AA4EA6300B7C361 /* libShieldFraudPlugin.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libShieldFraudPlugin.a; sourceTree = BUILT_PRODUCTS_DIR; };
-		665385E0D17A9E1D0BC4BB56 /* Pods-ShieldFraudPlugin.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-ShieldFraudPlugin.release.xcconfig"; path = "Target Support Files/Pods-ShieldFraudPlugin/Pods-ShieldFraudPlugin.release.xcconfig"; sourceTree = "<group>"; };
 		B3E7B5881CC2AC0600A0062D /* ShieldFraudPlugin.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ShieldFraudPlugin.h; sourceTree = "<group>"; };
 		B3E7B5891CC2AC0600A0062D /* ShieldFraudPlugin.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ShieldFraudPlugin.m; sourceTree = "<group>"; };
-		C1AD94D3D1982FF842092419 /* Pods-ShieldFraudPlugin.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-ShieldFraudPlugin.debug.xcconfig"; path = "Target Support Files/Pods-ShieldFraudPlugin/Pods-ShieldFraudPlugin.debug.xcconfig"; sourceTree = "<group>"; };
-		F046944AE9395EF1AEB8DB39 /* Pods_ShieldFraudPlugin.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_ShieldFraudPlugin.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -37,7 +33,6 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				F167571A67B6200098CBA80C /* Pods_ShieldFraudPlugin.framework in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -55,8 +50,6 @@
 		31EC8772E7BF66C38E51DB38 /* Pods */ = {
 			isa = PBXGroup;
 			children = (
-				C1AD94D3D1982FF842092419 /* Pods-ShieldFraudPlugin.debug.xcconfig */,
-				665385E0D17A9E1D0BC4BB56 /* Pods-ShieldFraudPlugin.release.xcconfig */,
 			);
 			path = Pods;
 			sourceTree = "<group>";
@@ -68,18 +61,9 @@
 				B3E7B5891CC2AC0600A0062D /* ShieldFraudPlugin.m */,
 				134814211AA4EA7D00B7C361 /* Products */,
 				31EC8772E7BF66C38E51DB38 /* Pods */,
-				DB1BDC55CCE65888ED19A665 /* Frameworks */,
 			);
 			sourceTree = "<group>";
 		};
-		DB1BDC55CCE65888ED19A665 /* Frameworks */ = {
-			isa = PBXGroup;
-			children = (
-				F046944AE9395EF1AEB8DB39 /* Pods_ShieldFraudPlugin.framework */,
-			);
-			name = Frameworks;
-			sourceTree = "<group>";
-		};
 /* End PBXGroup section */
 
 /* Begin PBXNativeTarget section */
@@ -87,7 +71,6 @@
 			isa = PBXNativeTarget;
 			buildConfigurationList = 58B511EF1A9E6C8500147676 /* Build configuration list for PBXNativeTarget "ShieldFraudPlugin" */;
 			buildPhases = (
-				D6EA6B2BCE68BAE66D6746A6 /* [CP] Check Pods Manifest.lock */,
 				58B511D71A9E6C8500147676 /* Sources */,
 				58B511D81A9E6C8500147676 /* Frameworks */,
 				58B511D91A9E6C8500147676 /* CopyFiles */,
@@ -133,31 +116,6 @@
 		};
 /* End PBXProject section */
 
-/* Begin PBXShellScriptBuildPhase section */
-		D6EA6B2BCE68BAE66D6746A6 /* [CP] Check Pods Manifest.lock */ = {
-			isa = PBXShellScriptBuildPhase;
-			buildActionMask = 2147483647;
-			files = (
-			);
-			inputFileListPaths = (
-			);
-			inputPaths = (
-				"${PODS_PODFILE_DIR_PATH}/Podfile.lock",
-				"${PODS_ROOT}/Manifest.lock",
-			);
-			name = "[CP] Check Pods Manifest.lock";
-			outputFileListPaths = (
-			);
-			outputPaths = (
-				"$(DERIVED_FILE_DIR)/Pods-ShieldFraudPlugin-checkManifestLockResult.txt",
-			);
-			runOnlyForDeploymentPostprocessing = 0;
-			shellPath = /bin/sh;
-			shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n    # print error to STDERR\n    echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n    exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n";
-			showEnvVarsInLog = 0;
-		};
-/* End PBXShellScriptBuildPhase section */
-
 /* Begin PBXSourcesBuildPhase section */
 		58B511D71A9E6C8500147676 /* Sources */ = {
 			isa = PBXSourcesBuildPhase;
@@ -267,7 +225,6 @@
 		};
 		58B511F01A9E6C8500147676 /* Debug */ = {
 			isa = XCBuildConfiguration;
-			baseConfigurationReference = C1AD94D3D1982FF842092419 /* Pods-ShieldFraudPlugin.debug.xcconfig */;
 			buildSettings = {
 				HEADER_SEARCH_PATHS = (
 					"$(inherited)",
@@ -284,7 +241,6 @@
 		};
 		58B511F11A9E6C8500147676 /* Release */ = {
 			isa = XCBuildConfiguration;
-			baseConfigurationReference = 665385E0D17A9E1D0BC4BB56 /* Pods-ShieldFraudPlugin.release.xcconfig */;
 			buildSettings = {
 				HEADER_SEARCH_PATHS = (
 					"$(inherited)",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-shield-fraud-plugin",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "React Native Shield Fraud Plugin helps developers to assess malicious activities performed on mobile devices and return risk intelligence based on user's behaviour. It collects device's fingerprint, social metrics and network information.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/ios/Podfile

@@ -1,10 +0,0 @@
-# Uncomment the next line to define a global platform for your project
-platform :ios, '11.0'
-
-target 'ShieldFraudPlugin' do
-  # Comment the next line if you don't want to use dynamic frameworks
-  use_frameworks!
-  
-  # Pods for ShieldFraudPlugin
-  pod 'ShieldFraud'
-end

package/ios/Podfile.lock

@@ -1,16 +0,0 @@
-PODS:
-  - ShieldFraud (1.5.28)
-
-DEPENDENCIES:
-  - ShieldFraud
-
-SPEC REPOS:
-  trunk:
-    - ShieldFraud
-
-SPEC CHECKSUMS:
-  ShieldFraud: d79af5280f65ba8b99188bffec32c33df18931ff
-
-PODFILE CHECKSUM: bb1ff44dc7cfd449bde1bb035f6a1eb25a54d48c
-
-COCOAPODS: 1.12.1

package/ios/Pods/Manifest.lock

@@ -1,16 +0,0 @@
-PODS:
-  - ShieldFraud (1.5.28)
-
-DEPENDENCIES:
-  - ShieldFraud
-
-SPEC REPOS:
-  trunk:
-    - ShieldFraud
-
-SPEC CHECKSUMS:
-  ShieldFraud: d79af5280f65ba8b99188bffec32c33df18931ff
-
-PODFILE CHECKSUM: bb1ff44dc7cfd449bde1bb035f6a1eb25a54d48c
-
-COCOAPODS: 1.12.1