@oiti/rn-liveness3d 1.1.2 → 2.1.0

package/README.md

@@ -1,248 +1,34 @@
-# 1. Sobre o Repositório
+<IMG  src="https://github.com/oititec/liveness-android-sdk/blob/main/Documentation/Images/OitiHeader.png?raw=true"  alt="OitiHeader.png"/>
 
-Este repositório é responsável pela biblioteca NPM do Liveness Oiti, com ele é possível instalar e usar a função de `startLiveness3d()` e a view `<Liveness3dView />` da Oititec disponíveis para aplicativos híbridos em React Native.
+# Oiti - Liveness 3D para React Native
 
-## 1.1 Requisitos Mínimos
+Neste repositório, encontramos a **biblioteca NPM do Liveness 3D da Oiti**.
 
-| Android     | iOS     |
-| ----------- | ------- |
-| Gradle: 6.8 | iOS: 11 |
+O NPM (Node Package Manager) é uma ferramenta para gerenciar pacotes no Node.js, a plataforma de execução para JavaScript. Com o NPM, você tem controle total sobre as dependências do seu projeto, permitindo acesso a um repositório de bibliotecas e frameworks JavaScript.
 
-# 2. O que é a biblioteca?
+Aqui, você pode instalar e utilizar funções como `startLiveness3d()`, além de incorporar a View como `<Liveness3dView />` em seus aplicativos híbridos desenvolvidos em React Native.
 
-O NPM (node package manager) é o gerenciador de pacotes do node.js (runtime de javascript).
+**Requisitos mínimos**
+| Android | iOS|
+|--|--|
+|Gradle: 6.8 | iOS: 11|
 
-Com o NPM você pode gerenciar dependências do seu projeto, acessar o repositório do NPM e ter acesso a inúmeras bibliotecas e frameworks JavaScript, permite a instalação/desinstalação dos mesmos assim como a criação de seus próprios módulos públicos ou privados.
+## Summary
 
-# 3. Uso (PASSO 1)
+Simplificamos nossos guias de integração e de customização do React Native:
 
-As instruções de uso, integração, implementação e customização do **Liveness Oiti** podem ser acessadas através das etapas abaixo:
+- [Guias de Instalação](https://devcenter.certiface.io/docs/guia-de-instalacao-react-native)
+- [Guia de Uso e Integração](https://devcenter.certiface.io/docs/guia-de-uso-e-integracao-react-native)
+- [Guia de Tratamento de Retorno](https://devcenter.certiface.io/docs/guia-de-tratamento-de-retornos-react-native)
+- [Guias de Customização](https://devcenter.certiface.io/docs/customizacao-rn)
 
-## 3.1. Instalação
+## Changelog
 
-Usando NPM:
+- As novidades das versões podem ser acessadas [neste link](https://www.npmjs.com/package/@oiti/rn-liveness3d?activeTab=versions).
 
-```bash
-npm install @oiti/rn-liveness3d
-```
-
-ou usando YARN
-
-```bash
-yarn add @oiti/rn-liveness3d
-```
-
-## 3.2. iOS Configuração
-
-Adicionar o Pod do FaceCaptcha no seu Podfile que está dentro da pasta `ios`
-
-```objectivec
-pod 'FaceCaptcha', '~> 4.10.0', :source => '<https://github.com/oititec/liveness-ios-specs.git>'
-```
-
-# 4. Uso no Javascript (PASSO 2)
-
-Primeiro devemos chamar a função desejada da biblioteca '@oiti/rn-liveness3d'
-
-```
-import { FUNÇÕES DESEJADAS } from '@oiti/rn-liveness3d';
-```
-
-## 4.1. Funções
-
-### Diagrama E2E startLiveness3d
-
-![E2Eliveness2d.png](%5BRN%5D%20@oiti%20rn-liveness3d%200bee6a0311a84f4987d656509cb76921/E2Eliveness2d.png)
-
-### 4.1.1. Funções Existentes
-
-| Função                 | Parâmetros | Retorno                    |
-| ---------------------- | ---------- | -------------------------- |
-| startLiveness3d(JSON); | options    | RESULT_OK, RESULT_CANCELED |
-
-> AppKey: gerada na etapa 2 da [documentação CertifaceID](https://certifaceid.readme.io/docs/integra%C3%A7%C3%A3o-atualizada)
-
-### 4.1.2. Exemplo de uso (Funções)
-
-Após efetuar a importação da biblioteca, deve ser aplicada a app Key gerada dentro do parâmetro da função desejada, no exemplo abaixo chamamos a função quando clicamos no botão "Liveness 3D"
-
-```jsx
-export default function App() {
-  const [result, setResult] = React.useState<string | undefined>();
-  const appKey = 'APP KEY';
-
-	const options = {
-    appkey: appKey,
-    environment: '.HML',
-    baseUrl: 'https://comercial.certiface.com.br:8443/',
-    apparence: {
-      backgroundColor: '#025951',
-      loadingColor: '#0CF25D',
-    },
-  };
-
-  return (
-    <View>
-    //Liveness3D
-      <Button
-        onPress={() => {
-          startLiveness3d(options).then(setResult);
-        }}
-        title="Liveness 3D"
-      />
-    </View>
-  );
-}
-
-```
-
-## 4.2. View Customizadas
-
-Na biblioteca é possível aplicar uma view/componente para customizar as telas de `instruções` e a tela de `permissão` de uso da câmera.
-
-| View               | Propriedades | Descrição |
-| ------------------ | ------------ | --------- |
-| <Liveness3dView /> | options      |
-
-navigation
-callbackView
-texts
-CustomInstructionView
-CustomPermissionView | View do Liveness 3d para carregar as telas customizadas. |
+## Flash tutorials
 
-### 4.2.1. Propriedades
-
-| Propriedade           | Obrigatoriedade | Tipo                  | Descrição                                                                                                             |
-| --------------------- | --------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| options               | SIM             | JSON                  | JSON de configurações da View                                                                                         |
-| navigation            | SIM             | React navigation prop | Ambiente que deseja estar rodando a aplicação                                                                         |
-| callbackView          | SIM             | string                | Endereço de endpoint da certiface, você pode usar uma string vazia caso deseje que a biblioteca defina um automático. |
-| texts                 | NÃO             | JSON                  | Textos personalizados da tela de captura tridimensional .                                                             |
-| CustomInstructionView | NÃO             | Component             | Aplica as propriedades de customização do carregamento antes de começar o Liveness3d.                                 |
-| CustomPermissionView  | NÃO             | Component             | Aplica as propriedades de customização do carregamento antes de começar o Liveness3d.                                 |
-
-### 4.2.2. JSON `options`
-
-Para aplicar as configurações na View você deve aplicar as seguintes propriedades em formato JSON no Javascript:
-
-```jsx
-const options = {
-  appkey: appKey,
-  environment: '.HML',
-  baseUrl: 'https://comercial.certiface.com.br:8443/',
-};
-```
-
-### 4.2.3. JSON `texts`
-
-```jsx
-const texts = {
-  READY_HEADER_1: 'Prepare-se para seu',
-  READY_HEADER_2: 'reconhecimento facial.',
-  READY_MESSAGE_1: 'Posicione o seu rosto na moldura, aproxime-se',
-  READY_MESSAGE_2: 'e toque em começar.',
-  READY_BUTTON: 'Começar',
-
-  RETRY_HEADER: 'Vamos tentar novamente?',
-  RETRY_SUBHEADER: 'Siga o exemplo de foto ideal abaixo:',
-  RETRY_MESSAGE_SMILE: 'Expressão Neutra, Sem Sorrir',
-  RETRY_MESSAGE_LIGHTING: 'Evite reflexos e iluminação extrema.',
-  RETRY_MESSAGE_CONTRAST: 'Limpe Sua Câmera',
-  RETRY_YOUR_PICTURE: 'Sua foto',
-  RETRY_IDEAL_PICTURE: 'Foto ideal',
-  RETRY_BUTTON: 'Tentar novamente',
-
-  RESULT_UPLOAD_MESSAGE: 'Enviando...',
-  RESULT_SUCCESS_MESSAGE: 'Sucesso',
-
-  FEEDBACK_CENTER_FACE: 'Centralize Seu Rosto',
-  FEEDBACK_FACE_NOT_FOUND: 'Enquadre o Seu Rosto',
-  FEEDBACK_FACE_NOT_LOOKING_STRAIGHT_AHEAD: 'Olhe Para Frente',
-  FEEDBACK_FACE_NOT_UPRIGHT: 'Mantenha a Cabeça Reta',
-  FEEDBACK_HOLD_STEADY: 'Segure Firme',
-  FEEDBACK_MOVE_PHONE_AWAY: 'Afaste-se',
-  FEEDBACK_MOVE_PHONE_CLOSER: 'Aproxime-se',
-  FEEDBACK_MOVE_PHONE_TO_EYE_LEVEL: 'Telefone ao Nível dos Olhos',
-  FEEDBACK_USE_EVEN_LIGHTING: 'Ilumine Seu Rosto Uniformemente',
-
-  FEEDBACK_FRAME_YOUR_FACE: 'Encaixe Seu Rosto no Espaço Oval',
-  FEEDBACK_HOLD_STEADY_1: 'Aguente Firme: 1',
-  FEEDBACK_HOLD_STEADY_2: 'Aguente Firme: 2',
-  FEEDBACK_HOLD_STEADY_3: 'Aguente Firme: 3',
-  FEEDBACK_REMOVE_DARK_GLASSES: 'Tire Seus Óculos de Sol',
-  FEEDBACK_NEUTRAL_EXPRESSION: 'Fique Neutro, Não Sorria',
-  FEEDBACK_CONDITIONS_TOO_BRIGHT: 'Ambiente Muito Iluminado',
-  FEEDBACK_BRIGHTEN_YOUR_ENVIRONMENT: 'Ambiente Muito Escuro',
-};
-```
-
-### 4.2.3. JSON `Loading`
-
-```jsx
-const loading = {
-  type: 'default' | 'spinner',
-  size: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10,
-  backgroundColor: string | undefined,
-  loadingColor: string | undefined,
-};
-```
-
-### 4.2.4. Chaves do `options`
-
-| View        | Valores                                  | Descrição                                                                                                             |
-| ----------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| appkey      | appKey                                   | App Key gerada no backend da aplicação e retornada para uso da biblioteca.                                            |
-| environment | '.HML', '.PRD'                           | Ambiente que deseja estar rodando a aplicação                                                                         |
-| baseUrl     | https://comercial.certiface.com.br:8443/ | Endereço de endpoint da certiface, você pode usar uma string vazia caso deseje que a biblioteca defina um automático. |
-| loading     | Objeto de customização                   | Aplica as propriedades de customização do loading antes de começar o Liveness3d.                                      |
-
-### 4.2.5. Exemplo de uso (View Customizada)
-
-Para utilizar uma view customizada você pode aplicar o seguinte código em sua biblioteca React Native.
-
-```jsx
-import * as React from 'react';
-
-import { Liveness3dView } from '@oiti/rn-liveness3d';
-
-export default function Documentscopy({ navigation }: { navigation: any }) {
-  const appKey = 'SUA_APP_KEY_AQUI';
-  const options = {
-    appkey: appKey,
-    environment: '.HML',
-    baseUrl: 'https://comercial.certiface.com.br:8443/',
-  };
-
-  const loading = {
-    type: 'spinner',
-    size: 5,
-    backgroundColor: '#000000',
-    loadingColor: '#0CF25D',
-  };
-
-  const texts = {
-    READY_HEADER_1: 'Prepare-se para seu',
-    READY_HEADER_2: 'reconhecimento facial.',
-    READY_MESSAGE_1: 'Posicione o seu rosto na moldura, aproxime-se',
-    READY_MESSAGE_2: 'e toque em começar.',
-    READY_BUTTON: 'Começar',
-  };
-
-  return (
-    <Liveness3dView
-      options={options}
-      navigation={navigation}
-      texts={texts}
-      loading={loading}
-      callbackView="Home"
-      CustomInstructionView={CustomInstructionView}
-      CustomPermissionView={CustomPermissionView}
-    />
-  );
-}
-```
-
-# 5. Como executar o clone do Repositório?
+### Como executar o clone do repositório?
 
 Execute o código abaixo em seu terminal para clonar o código:
 
@@ -250,21 +36,21 @@ Execute o código abaixo em seu terminal para clonar o código:
 git clone https://github.com/oititec/rn-liveness3d
 ```
 
-# 6. Como rodar o Script?
+### Como rodar o script?
 
 Para rodar o script desse repositório você deve instalar as dependências do projeto, então na pasta root do projeto clonado rodar o comando.
 
-## 6.1 Yarn
+**Yarn**
 
 ```bash
 yarn
 ```
 
-## 6.2 Executar Projeto
+**Executar Projeto**
 
 > Executar sempre em dispositivos físicos e não no simulador do iOS e Android
 
-Yarn
+**Yarn**
 
 ```bash
 yarn example android
@@ -273,3 +59,13 @@ yarn example android
 ```bash
 yarn example ios
 ```
+
+## Saiba mais
+
+- Conhecer as **ferramentas de prevenção à fraude** e suas funcionalidades: [consulte este link](https://devcenter.certiface.io/docs/certiface-funcionalidades).
+
+- Acessar quadro de **compatibilidade de sistemas e drivers**: [consulte este link](https://devcenter.certiface.io/docs/compatibilidade-dos-servicos).
+
+- Entrar em contato com o **atendimento Oiti**: [consulte este link](https://devcenter.certiface.io/docs/portal-de-atendimento).
+
+---

package/android/build.gradle

@@ -14,7 +14,6 @@ buildscript {
     classpath 'com.android.tools.build:gradle:3.5.3'
     // noinspection DifferentKotlinGradleVersion
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-    classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
   }
 }
 
@@ -24,7 +23,6 @@ def isNewArchitectureEnabled() {
 
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
-apply plugin: 'kotlinx-serialization'
 
 if (isNewArchitectureEnabled()) {
   apply plugin: 'com.facebook.react'
@@ -64,8 +62,9 @@ android {
 }
 
 repositories {
-  mavenCentral()
   google()
+  mavenCentral()
+  maven { url "https://raw.githubusercontent.com/oititec/android-oiti-versions/master" }
 
   def found = false
   def defaultDir = null
@@ -140,21 +139,8 @@ dependencies {
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
-  implementation 'androidx.core:core-ktx:1.7.0'
-  implementation 'androidx.appcompat:appcompat:1.4.1'
-  implementation 'com.google.android.material:material:1.6.1'
-  implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
-  implementation "org.bouncycastle:bcprov-jdk16:1.46"
-  implementation "com.squareup.okhttp3:logging-interceptor:4.9.3"
-  implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.3.1'
-  implementation 'androidx.fragment:fragment-ktx:1.3.6'
-  implementation group: 'com.google.code.gson', name: 'gson', version: '2.9.0'
-  implementation group: 'com.squareup.retrofit2', name: 'converter-gson', version: '2.9.0'
-  implementation "com.squareup.retrofit2:retrofit:2.9.0"
-  implementation 'androidx.databinding:databinding-runtime:4.2.2'
-
-  implementation 'br.com.oiti:liveness3d-sdk:8.1.4'
-  implementation 'br.com.oiti:security:1.2'
+  implementation 'br.com.oiti:liveness3d-sdk:9.2.6'
+
 
 // From node_modules
 }

package/android/settings.gradle

@@ -1,6 +1,6 @@
 dependencyResolutionManagement {
-    // repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    //repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
     repositories {
-        maven { url "https://raw.githubusercontent.com/oititec/android-oiti-versions/master" }
+      maven { url "https://raw.githubusercontent.com/oititec/android-oiti-versions/master" }
     }
 }

package/android/src/main/AndroidManifest.xml

@@ -1,6 +1,9 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
           package="br.com.oiti.rnliveness3d">
 
+  <uses-permission android:name="android.permission.INTERNET" />
+  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
   <uses-permission android:name="android.permission.CAMERA" />
+  <uses-permission android:name="android.permission.READ_PHONE_STATE" />
 
 </manifest>