@socure-inc/docv-react-native 4.0.0-alpha.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +10 -18
  2. package/package.json +1 -1
  3. package/socure-docv-react-native.podspec +1 -1
  4. package/src/index.tsx +1 -1
package/README.md CHANGED
@@ -1,24 +1,26 @@
1
- # Predictive DocV SDK v3 React Native
1
+ # Predictive DocV SDK v4 React Native
2
2
 
3
- The Predictive Document Verification (DocV) SDK v3 for React Native is a React Native wrapper that allows you to use the DocV SDK for Android and iOS in your React Native application.
3
+ The Predictive Document Verification (DocV) SDK v4 for React Native is a React Native wrapper that allows you to use the DocV SDK for Android and iOS in your React Native application.
4
4
 
5
- > Note: Document verification services will be disabled for older SDK versions soon. All SDK v3 integrations must be updated to version **3.1.0 or later** to meet compliance requirements.
5
+ >Note: Document verification services will be disabled for older SDK versions soon. All SDK integrations must be updated to version **3.1.0 or later** to meet compliance requirements.
6
6
 
7
7
  ## Minimum Requirements
8
8
 
9
+ Before getting started, check that your development environment meets the following requirements:
10
+
9
11
  **React Native**
10
12
 
11
13
  - React Native CLI. See the [React Native docs](https://reactnative.dev/docs/environment-setup) for instructions on how to set up your development environment.
12
14
 
13
15
  **iOS**
14
16
 
15
- - Support for iOS 13 and later
16
17
  - Xcode version 14.1+
18
+ - Support for iOS 13 and later
17
19
 
18
20
  **Android**
19
21
 
20
22
  - Android SDK Version 22 (OS Version 5.1) and later
21
- - Android SDK is compiled with `compileSdkVersion` 33 and Java 11
23
+ - Android SDK is compiled with `compileSdkVersion 33` and Java 11
22
24
 
23
25
  ## Getting started
24
26
 
@@ -63,18 +65,13 @@ Once completed, your Podfile should look like the following example:
63
65
  ```swift {4,36}
64
66
  require_relative '../node_modules/react-native/scripts/react_native_pods'
65
67
  require_relative '../node_modules/@react-native-community/cli-platform-ios/native_modules'
66
-
67
68
  platform :ios, '13.0'
68
69
  install! 'cocoapods', :deterministic_uuids => false
69
-
70
70
  production = ENV["PRODUCTION"] == "1"
71
-
72
71
  target 'SocureDocVDemo' do
73
72
  config = use_native_modules!
74
-
75
73
  # Flags change depending on the env values.
76
74
  flags = get_default_flags()
77
-
78
75
  use_react_native!(
79
76
  :path => config[:reactNativePath],
80
77
  # to enable hermes on iOS, change `false` to `true` and then install pods
@@ -85,19 +82,15 @@ target 'SocureDocVDemo' do
85
82
  # An absolute path to your application root.
86
83
  :app_path => "#{Pod::Config.instance.installation_root}/.."
87
84
  )
88
-
89
85
  target 'SocureDocVDemoTests' do
90
86
  inherit! :complete
91
87
  # Pods for testing
92
88
  end
93
-
94
89
  post_install do |installer|
95
90
  react_native_post_install(installer)
96
91
  __apply_Xcode_12_5_M1_post_install_workaround(installer)
97
92
  end
98
-
99
93
  pod 'socure-docv-react-native', :path => '../node_modules/@socure-inc/docv-react-native'
100
-
101
94
  end
102
95
  ```
103
96
 
@@ -131,7 +124,7 @@ The DocV iOS SDK requires a device's camera permission to capture identity docum
131
124
  | Privacy - Camera Usage Description | String | "This application requires use of your camera in order to capture your identity documents." |
132
125
 
133
126
 
134
- > **Note:** We recommend you check for camera permission before calling the SocureDocV SDK’s launch API. 
127
+ > **Note:** We recommend you check for camera permission before calling the SocureDocV SDK’s launch API.
135
128
 
136
129
  ### Run the app
137
130
 
@@ -176,7 +169,6 @@ Ensure that your app manifest has been set up properly to request the following
176
169
 
177
170
  ```
178
171
  <uses-feature android:name="android.hardware.camera" />
179
-
180
172
  <!-- Declare permissions -->
181
173
  <uses-permission android:name="android.permission.CAMERA" />
182
174
  <uses-permission android:name="android.permission.INTERNET" />
@@ -217,7 +209,7 @@ The following table lists the available `launchSocureDocV` properties:
217
209
 
218
210
  | Argument | Description |
219
211
  | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
220
- | `socure_sdk_key` | The unique SDK key obtained from Admin Dashboard. For more information on SDK keys, see the [SDK Keys](https://developer.socure.com/docs/admin-dashboard/developers/sdk-keys) article in DevHub.article. |
212
+ | `socure_sdk_key` | The unique SDK key obtained from Admin Dashboard. For more information, see the [SDK Keys](https://developer.socure.com/docs/admin-dashboard/developers/sdk-keys) article in DevHub. |
221
213
  | `flow` | An optional JSON string or null value that specifies a custom flow. <br /><br /> `JSON.stringify({flow: {name: “FLOW_NAME”}, document_type: 'license'})` <br /><br />The `flow_name` value specifies the name of the customized Capture App UI flow (created in Admin Dashboard) that the DocV SDK should use for each transaction. If the value is incorrect or `null`, the DocV SDK will use flow set as **Default** in Admin Dashboard. <br /><br />The `document_type` value specifies a single acceptable document type for the transaction and skips the **Selected ID Type Screen** in the Capture App flow. Possible field values are `license` or `passport`. If the value is incorrect or `null`, the DocV SDK will use the document type defined for the flow in Admin Dashboard. | | |
222
214
  | `onSuccess` | A callback function that notifies you when the flow completes successfully. | | |
223
215
  | `onError` | A callback function that notifies you when the flow fails. | | |
@@ -316,4 +308,4 @@ The following table lists the errors that can be returned by Socure DocV SDK:
316
308
  | `7107` | `Unknown error` |
317
309
  | `7108` | `Camera resolution doesn't match the minimum requirement` |
318
310
  | `7109` | `Invalid config data` |
319
- | `7110` | `Consent declined` |
311
+ | `7110` | `Consent declined` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@socure-inc/docv-react-native",
3
- "version": "4.0.0-alpha.0",
3
+ "version": "4.0.0",
4
4
  "description": "The Predictive Document Verification (DocV) SDK React Native bridge allows you to use the DocV SDK v4 for Android and iOS in your React Native application.",
5
5
  "main": "src/index",
6
6
  "types": "dist/index.d.ts",
package/socure-docv-react-native.podspec CHANGED
@@ -18,6 +18,6 @@ Pod::Spec.new do |s|
18
18
  s.source_files = "ios/**/*.{h,m,mm,swift}"
19
19
 
20
20
  s.dependency "React"
21
- s.dependency "SocureDocV", "4.0.0"
21
+ s.dependency "SocureDocV", "4.0.1"
22
22
 
23
23
  end
package/src/index.tsx CHANGED
@@ -28,7 +28,7 @@ export function launchSocureDocV(socureApiKey: string, flow: string | null | und
28
28
  Please contact Socure before starting to use this.
29
29
  */}
30
30
  export function initDocVSdk(socureApiKey: string, flow: string | null | undefined) {
31
- if (typeof socureApiKey === "string") {
31
+ if (socureApiKey && typeof socureApiKey === "string") {
32
32
  if ((!flow && flow !== "") || (typeof flow === "string" && isValidJSON(flow))) {
33
33
  SocureDocVReactNative.initDocVSdk(socureApiKey, flow);
34
34
  } else {