react-native-shield-full-plugin 2.3.0

package/lib/typescript/src/index.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Enum representing the log levels for ShieldFraud.
+ */
+export declare enum LogLevel {
+    LogLevelVerbose = 4,
+    LogLevelDebug = 3,
+    LogLevelInfo = 2,
+    LogLevelNone = 1
+}
+/**
+ * Enum representing the environment information for ShieldFraud.
+ */
+export declare enum EnvironmentInfo {
+    EnvironmentProd = 0,
+    EnvironmentDev = 1,
+    EnvironmentStaging = 2
+}
+/**
+ * Configuration object for initializing ShieldFraud.
+ */
+export interface Config {
+    siteID: string;
+    secretKey: string;
+    blockedDialog?: {
+        title: string;
+        body: string;
+    } | null;
+    logLevel?: LogLevel;
+    environmentInfo?: EnvironmentInfo;
+    /**
+     * Android-only: when true, the Shield SDK will block screen recording
+     * while it is active. Has no effect on iOS (the value is forwarded but
+     * the native side ignores it). Defaults to false when not provided.
+     */
+    blockScreenRecording?: boolean;
+}
+/**
+ * Type definition for the success callback function.
+ */
+type SuccessCallback = (data: any) => void;
+/**
+ * Type definition for the failure callback function.
+ */
+type FailureCallback = (error: any) => void;
+/**
+ * Type definition for the ShieldFraud callback functions.
+ */
+export type ShieldCallback = {
+    onSuccess?: SuccessCallback;
+    onFailure?: FailureCallback;
+};
+/**
+ * The `ShieldFraud` class is a wrapper for the ShieldFraudPlugin native module in React Native.
+ * It provides methods for initializing ShieldFraud, retrieving session ID, checking the SDK readiness,
+ * sending attributes, and getting the latest device result.
+ */
+declare class ShieldFraud {
+    /**
+     * The native module for accessing the ShieldFraudPlugin.
+     * Resolved via TurboModuleRegistry on New Architecture, with
+     * a NativeModules bridge fallback for Old Architecture.
+     */
+    private static PlatformWrapper;
+    /**
+     * The event emitter for listening to success and error events.
+     */
+    private static eventEmitter;
+    private static callbackSubscriptions;
+    /**
+     * Initializes the ShieldFraud plugin with the provided configuration.
+     *
+     * @param config - The configuration object containing the required properties.
+     * @param callbacks - (Optional) The callback functions for success and failure events.
+     */
+    static initShield(config: Config, callbacks?: ShieldCallback): Promise<void>;
+    /**
+     * Private method to set cross-platform parameters.
+     * The cross-platform name and the version is fetched from package.json.
+     */
+    private static setCrossPlatformParameters;
+    /**
+     * Sets up event listeners for success and error events.
+     *
+     * @param callbacks - The callback functions for success and failure events.
+     */
+    private static listeners;
+    /**
+     * Retrieves the session ID from the ShieldFraud plugin.
+     *
+     * @returns The current session ID.
+     */
+    static getSessionId(): string;
+    /**
+     * Checks whether the ShieldFraud plugin is initialized.
+     *
+     * @returns Whether the ShieldFraud plugin is initialized.
+     */
+    static isShieldInitialized(): boolean;
+    /**
+     * Checks if the ShieldFraud SDK is ready and invokes the provided callback
+     * with the readiness state.
+     *
+     * On Android, readiness is approximated by the native initialization state
+     * to preserve backward compatibility without reporting ready before init.
+     *
+     * @param callback - A callback function to be invoked with the readiness state.
+     *   - `isReady` (boolean): true when the SDK has produced a device result.
+     */
+    static isSDKready(callback: (isReady: boolean) => void): Promise<void>;
+    /**
+     * Sends attributes to the ShieldFraud plugin for a specific screen.
+     *
+     * @param screenName - The name of the screen.
+     * @param data - The attribute data object.
+     */
+    static sendAttributes(screenName: string, data: object): void;
+    /**
+     * Sends attributes and resolves with `true` when the native SDK confirms success.
+     *
+     * @param screenName - The name of the screen.
+     * @param data - The attribute data object.
+     * @returns A Promise that resolves to true on success and rejects on error.
+     */
+    static sendAttributesWithCallback(screenName: string, data: object): Promise<boolean>;
+    /**
+     * Retrieves the latest device result from the ShieldFraud plugin.
+     *
+     * @returns A Promise that resolves with the latest device result object.
+     */
+    static getLatestDeviceResult(): Promise<object>;
+    /**
+     * Triggers a device signature computation for a given screen name.
+     * On success, resolves with the latest device result object.
+     * On failure, rejects with the error message.
+     *
+     * @param screenName - The name of the screen triggering the signature.
+     * @param userId - (Optional) A user ID to associate with the device signature.
+     * @returns A Promise that resolves with the device result or rejects with an error.
+     */
+    static sendDeviceSignature(screenName: string, userId?: string): Promise<object>;
+}
+export default ShieldFraud;
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAgBA;;GAEG;AACH,oBAAY,QAAQ;IAClB,eAAe,IAAI;IACnB,aAAa,IAAI;IACjB,YAAY,IAAI;IAChB,YAAY,IAAI;CACjB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,eAAe,IAAI;IACnB,cAAc,IAAI;IAClB,kBAAkB,IAAI;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE;QACd,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,IAAI,CAAC;IACT,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,KAAK,eAAe,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;AAE3C;;GAEG;AACH,KAAK,eAAe,GAAG,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,cAAM,WAAW;IACf;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe,CAAiC;IAE/D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY,CAEzB;IAEF,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAG7B;IAEP;;;;;OAKG;WACiB,UAAU,CAC5B,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,IAAI,CAAC;IAoChB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAUzC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,SAAS;IAqBxB;;;;OAIG;WACW,YAAY,IAAI,MAAM;IAIpC;;;;OAIG;WACW,mBAAmB,IAAI,OAAO;IAI5C;;;;;;;;;OASG;WACiB,UAAU,CAC5B,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GACnC,OAAO,CAAC,IAAI,CAAC;IAuChB;;;;;OAKG;WACW,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAIpE;;;;;;OAMG;WACW,0BAA0B,CACtC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,OAAO,CAAC;IAenB;;;;OAIG;WACW,qBAAqB,IAAI,OAAO,CAAC,MAAM,CAAC;IAatD;;;;;;;;OAQG;WACW,mBAAmB,CAC/B,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;CAcnB;AAED,eAAe,WAAW,CAAC"}

package/package.json

@@ -0,0 +1,169 @@
+{
+  "name": "react-native-shield-full-plugin",
+  "version": "2.3.0",
+  "description": "React Native Shield Full 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",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "!lib/typescript/example",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "test": "jest",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "prepack": "bob build",
+    "release": "release-it",
+    "example": "yarn --cwd example",
+    "bootstrap": "yarn example && yarn install && yarn example pods",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build",
+    "bump": "bash scripts/bump-version.sh",
+    "publish": "node scripts/publish.js",
+    "use-fraud": "node scripts/use-plugin.js fraud",
+    "use-full": "node scripts/use-plugin.js full"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android",
+    "shieldfull",
+    "device-intelligence",
+    "mobile-fingerprint"
+  ],
+  "repository": "https://github.com/shield-ai-technology/react-native-shield-fraud-plugin",
+  "author": "www.shield.com",
+  "license": "MIT",
+  "homepage": "https://github.com/shield-ai-technology/react-native-shield-fraud-plugin#readme",
+  "devDependencies": {
+    "@evilmartians/lefthook": "^1.2.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@react-native-community/eslint-config": "^3.0.2",
+    "@release-it/conventional-changelog": "^5.0.0",
+    "@types/jest": "^28.1.2",
+    "@types/react": "~17.0.21",
+    "@types/react-native": "0.70.0",
+    "commitlint": "^17.0.2",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.4.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^28.1.1",
+    "pod-install": "^0.1.0",
+    "prettier": "^2.0.5",
+    "react": "18.2.0",
+    "react-native": "0.71.7",
+    "react-native-builder-bob": "^0.20.0",
+    "release-it": "^15.0.0",
+    "typescript": "^4.5.2"
+  },
+  "resolutions": {
+    "@types/react": "17.0.21"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "packageManager": "yarn@1.22.15",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native-community",
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "RNShieldFraudPluginSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.shieldfraudplugin"
+    }
+  }
+}

package/react-native-shield-fraud-plugin.podspec

@@ -0,0 +1,29 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = package["name"]
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "12.0" }
+  s.source       = { :git => "https://github.com/shield-ai-technology/react-native-shield-fraud-plugin.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm}"
+
+  # Enable Clang modules in C++ mode so that @import ShieldFraud; works
+  s.pod_target_xcconfig = {
+    'CLANG_ENABLE_MODULES'  => 'YES',
+    'OTHER_CPLUSPLUSFLAGS'  => '$(inherited) -fmodules -fcxx-modules'
+  }
+
+  # install_modules_dependencies handles New Architecture (Turbo Modules / Fabric)
+  # and replaces the legacy `s.dependency "React"` call.
+  install_modules_dependencies(s)
+
+  s.dependency "ShieldFraud", ">= 1.5.59"
+end

package/react-native-shield-full-plugin.podspec

@@ -0,0 +1,29 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = package["name"]
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "12.0" }
+  s.source       = { :git => "https://github.com/shield-ai-technology/react-native-shield-fraud-plugin.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm}"
+
+  # Enable Clang modules in C++ mode so that @import ShieldFraud; works
+  s.pod_target_xcconfig = {
+    'CLANG_ENABLE_MODULES'  => 'YES',
+    'OTHER_CPLUSPLUSFLAGS'  => '$(inherited) -fmodules -fcxx-modules'
+  }
+
+  # install_modules_dependencies handles New Architecture (Turbo Modules / Fabric)
+  # and replaces the legacy `s.dependency "React"` call.
+  install_modules_dependencies(s)
+
+  s.dependency "ShieldFraud", ">= 1.5.58"
+end

package/src/NativeShieldFraudPlugin.ts

@@ -0,0 +1,87 @@
+import type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+/**
+ * TypeScript spec for the ShieldFraudPlugin Turbo Module.
+ * This file is used by React Native codegen to auto-generate
+ * native interface code for both iOS and Android.
+ */
+export interface Spec extends TurboModule {
+  /**
+   * Initializes the ShieldFraud SDK with the provided configuration.
+   */
+  initShield(
+    siteID: string,
+    secretKey: string,
+    isOptimizedListener: boolean,
+    blockedDialog: Object | null,
+    logLevel: number,
+    environmentInfo: number,
+    /** Android-only: block screen recording while the SDK is active. Ignored on iOS. */
+    blockScreenRecording: boolean
+  ): Promise<void>;
+
+  /**
+   * Sets cross-platform metadata (name + version) on the SDK.
+   */
+  setCrossPlatformParameters(
+    crossPlatformName: string,
+    crossPlatformVersion: string
+  ): void;
+
+  /**
+   * Returns the current session ID synchronously.
+   */
+  getSessionId(): string;
+
+  /**
+   * Returns whether the SDK has been initialized synchronously.
+   */
+  isShieldInitialized(): boolean;
+
+  /**
+   * Registers a listener for the device-result-ready state event.
+   */
+  setDeviceResultStateListener(): void;
+
+  /**
+   * Sends custom attributes for a given screen name.
+   */
+  sendAttributes(screenName: string, data: Object): void;
+
+  /**
+   * Sends custom attributes for a given screen name with success/error callbacks.
+   */
+  sendAttributesWithCallback(
+    screenName: string,
+    data: Object,
+    successCallback: (result: boolean) => void,
+    errorCallback: (error: string) => void
+  ): void;
+
+  /**
+   * Retrieves the latest device result via success/error callbacks.
+   */
+  getLatestDeviceResult(
+    successCallback: (result: Object) => void,
+    errorCallback: (error: Object) => void
+  ): void;
+
+  /**
+   * Triggers a device signature computation for a given screen and returns
+   * the latest device result (or error) via callbacks once complete.
+   * Pass userId to associate the result with a specific user.
+   */
+  sendDeviceSignature(
+    screenName: string,
+    userId: string | null,
+    successCallback: (result: Object) => void,
+    errorCallback: (error: string) => void
+  ): void;
+
+  // Required by RCTEventEmitter for New Architecture compatibility
+  addListener(eventName: string): void;
+  removeListeners(count: number): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('ShieldFraudPlugin');