Skip to content

Commit

Permalink
Release 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@Miquel-Martinez
Miquel-Martinez committed Oct 23, 2023
1 parent a3675a3 commit 50136ce
Show file tree
Hide file tree
Showing 23 changed files with 1,213 additions and 903 deletions.
48 changes: 17 additions & 31 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The iProov Biometrics React Native SDK wraps iProov's native iOS (Swift) and And
### Requirements

- React Native 0.60 and above
- iOS 11 and above
- iOS 12 and above
- Android API Level 21 (Android 5 Lollipop) and above

## Repository contents
Expand All @@ -42,7 +42,7 @@ You can obtain API credentials by registering on the [iProov Partner Portal](htt

```json
"dependencies": {
"iproov-react-native": "git+ssh://[email protected]:iProov/react-native.git#0.2.0"
"iproov-react-native": "git+ssh://[email protected]:iProov/react-native.git#0.3.0"
}
```

Expand Down Expand Up @@ -71,7 +71,7 @@ You can obtain API credentials by registering on the [iProov Partner Portal](htt
```ruby
pre_install do |installer|
installer.pod_targets.each do |pod|
if !['iProov', 'Starscream'].include?(pod.name)
if !['iProov'].include?(pod.name)
def pod.static_framework?;
true
end
Expand All @@ -82,21 +82,6 @@ You can obtain API credentials by registering on the [iProov Partner Portal](htt
end
end
```
3. **Enable module stability** - iProov and its dependencies require `BUILD_LIBRARY_FOR_DISTRIBUTION` to be enabled. Add the following `post_install` step (or add it to your existing `post_install` step if you have one already):

```ruby
post_install do |installer|
installer.pods_project.targets.each do |target|
if ['iProov', 'Starscream'].include? target.name
target.build_configurations.each do |config|
config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
end
end
end
end
```

2. In your React Native app `ios` directory, run:

```sh
Expand Down Expand Up @@ -153,13 +138,13 @@ IProov.launch('wss://eu.rp.secure.iproov.me/ws', "< YOUR TOKEN >", options, (eve
let message = event.params.message
break

case IProov.EVENT_CANCELLED:
// Either the user cancelled iProov by pressing the Close button at the top or
// the Home button (canceller == USER)
// Or the app cancelled using Session.cancel() (canceller = APP).
case IProov.EVENT_CANCELED:
// Either the user canceled iProov by pressing the Close button at the top or
// the Home button (canceler == USER)
// Or the app canceled using Session.cancel() (canceler = APP).
// You should use this to determine the next step in your flow.

let canceller = event.params.canceller
let canceler = event.params.canceler
break

case IProov.EVENT_FAILURE:
Expand Down Expand Up @@ -216,7 +201,7 @@ A summary of the support for the various SDK options in React Native is provided
| `titleTextColor` | `String` (#rgba) | ✅ | ✅ |
| `surroundColor` | `String` (#rgba) | ✅ | ✅ |
| `font` | `String` | ✅ | ✅ |
| `fontPath` (1) | Unsupported | ❌ | ❌ |
| `fontPath` (*) | Unsupported | ❌ | ❌ |
| `logoImage` | `String` (Base64-encoded image) | ✅ | ✅ |
| `closeButtonImage` | `String` (Base64-encoded image) | ✅ | ✅ |
| `closeButtonTintColor` | `String` (#rgba) | ✅ | ✅ |
Expand All @@ -225,20 +210,16 @@ A summary of the support for the various SDK options in React Native is provided
| `enableScreenshots` | `Boolean` | | ✅ |
| `orientation` | `Options.(PORTRAIT\|LANDSCAPE\|REVERSE_PORTRAIT\|REVERSE_LANDSCAPE)`| | ✅ |
| `camera` | `Options.(FRONT\|EXTERNAL)` | | ✅ |
| `faceDetector` | `Options.(AUTO\|CLASSIC\|ML_KIT\|BLAZEFACE)` | | ✅ |
| `headerBackgroundColor` | `String` (#rgba) | ✅ | ✅ |
| `disableExteriorEffects` | `Boolean` | ✅ | ✅ |
| **`Options.genuinePresenceAssurance.`** | | | |
| ↳`notReadyOvalStrokeColor ` | `String` (#rgba) | ✅ | ✅ |
| ↳`readyOvalStrokeColor ` | `String` (#rgba) | ✅ | ✅ |
| ↳`maxPitch` (2) | `Number` | ✅ | ✅ |
| ↳`maxYaw` (2) | `Number` | ✅ | ✅ |
| ↳`maxRoll` (2) | `Number` | ✅ | ✅ |
| **`Options.livenessAssurance.`** | | | |
| ↳`ovalStrokeColor` | `String` (#rgba) | ✅ | ✅ |
| ↳`completedOvalStrokeColor` | `String` (#rgba) | ✅ | ✅ |

(1) Custom fonts are not currently supported and will be added in a future version of the React Native SDK.

(2) These options are deprecated and will be removed in a future release.
(*) Custom fonts are not currently supported and will be added in a future version of the React Native SDK.

### Filter Options

Expand Down Expand Up @@ -291,10 +272,15 @@ IProov listener error events will contain an `error` string within the events `p
| `camera_permission_error` | ✅ | ✅ | The user disallowed access to the camera when prompted. You should direct the user to re-enable camera access. |
| `server_error` | ✅ | ✅ | A server-side error/token invalidation occurred. The associated `message` will contain further information about the error. |
| `unexpected_error` | ✅ | ✅ | An unexpected and unrecoverable error has occurred. These errors should be reported to iProov for further investigation. |
| `unsupported_device_error` |✅ | ✅ | Device is not supported.|
| `multi_window_unsupported_error` | | ✅ | The user attempted to iProov in split-screen/multi-screen mode, which is not supported. |
| `camera_error` | | ✅ | An error occurred acquiring or using the camera. This could happen when a non-phone is used with/without an external/USB camera. |
| `face_detector_error` | | ✅ | An error occurred with the face detector. |
| `invalid_options_error` | | ✅ | An error occurred when trying to apply your options. |
| `user_timeout_error` |✅ | | The user has taken too long to complete the claim.|




## Localization

Expand Down
10 changes: 5 additions & 5 deletions android/build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:7.0.3'
classpath 'com.android.tools.build:gradle:7.4.1'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}
}
Expand All @@ -14,12 +14,12 @@ apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'

android {
compileSdkVersion 31
buildToolsVersion "31.0.0"
compileSdkVersion 33
buildToolsVersion "33.0.0"

defaultConfig {
minSdkVersion 21
targetSdkVersion 31
targetSdkVersion 33
versionCode 1
versionName "1.0"
}
Expand All @@ -36,7 +36,7 @@ repositories {
}

dependencies {
implementation 'com.iproov.sdk:iproov:8.3.1'
implementation 'com.iproov.sdk:iproov:9.0.1'
implementation 'com.facebook.react:react-native:+'
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
}
Binary file added android/gradle/wrapper/gradle-wrapper.jar
View file
Binary file not shown.
5 changes: 5 additions & 0 deletions android/gradle/wrapper/gradle-wrapper.properties
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
234 changes: 234 additions & 0 deletions android/gradlew
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
#!/bin/sh

#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################

# Attempt to set APP_HOME

# Resolve links: $0 may be a link
app_path=$0

# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done

APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

APP_NAME="Gradle"
APP_BASE_NAME=${0##*/}

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum

warn () {
echo "$*"
} >&2

die () {
echo
echo "$*"
echo
exit 1
} >&2

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar


# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi

# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.

# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )

JAVACMD=$( cygpath --unix "$JAVACMD" )

# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi

# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.

set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"

# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#

eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'

exec "$JAVACMD" "$@"
Loading

0 comments on commit 50136ce

Please sign in to comment.