@b8safe/react-native-safe/README.md

Package for native integration of B8Safe SDK

# react-native-b8safe

SDK para integração dos serviços da B8Safe em aplicações React-Native.

##

## Installation
Detalhes sobre a instalação, consulte a [documentação](https://github.com/brbtcoficial/react-native-b8safe/blob/master/Documentation/Installation.md).
```sh
npm install @b8safe/react-native-safe
```

### Dependencies
Verifique se as dependencias abaixo estão corretamente instaladas e configuradas. Em caso de dúvidas ou problemas com alguma dependência, acesse diretamente os repositórios:

- [react-native-webrtc](https://github.com/react-native-webrtc/react-native-webrtc)
- [react-native-sha256](https://github.com/itinance/react-native-sha256)
- [react-native-permissions](https://github.com/zoontek/react-native-permissions)
- [react-native-vision-camera](https://github.com/mrousavy/react-native-vision-camera)
- [@shopify/react-native-skia](https://shopify.github.io/react-native-skia/docs/getting-started/installation)
- [react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/)
- [react-native-svg](https://github.com/software-mansion/react-native-svg?tab=readme-ov-file#installation)

Dica: Verifique o passo a passo para a instalação de cada dependência, de acordo com as versões apontadas no arquivo [package.json](https://github.com/brbtcoficial/react-native-b8safe/blob/master/package.json).

## Android configuration
### 1 - Ativando o processador de frames
Você precisará adicionar a biblioteca ao arquivo `android/app/build.gradle`:
```java
android {
  // ...

  namespace "my.application.id"
  defaultConfig {
    versionCode 000
    versionName '0.0.00'
    // ...
    multiDexEnabled true
  }

  // ...
}

dependencies {
  // ...
  implementation project(':@b8safe_react-native-safe')    // <-- add this
  // ...
}
```

Depois, no arquivo `android/app/src/main/java/my/application/id/MainApplication.java`, adicione:
```java
package my.application.id;

// ...
import br.com.b8.safe.B8SafeFrameProcessorPluginPackage;    // <-- add this
// ...

public class MainApplication extends MultiDexApplication implements ReactApplication {
  // private final ReactModuleRegistryProvider mModuleRegistryProvider = new ReactModuleRegistryProvider(new BasePackageList().getPackageList(), null);

  private final ReactNativeHost mReactNativeHost = new DefaultReactNativeHost(this) {
    // ...

    @Override
    protected List<ReactPackage> getPackages() {
      @SuppressWarnings("UnnecessaryLocalVariable")
      List<ReactPackage> packages = new PackageList(this).getPackages();

      // ...
      packages.add( new B8SafeFrameProcessorPluginPackage() );    // <-- add this
      // ...
      
      return packages;
    }

    // ...
  }
}
```

## Basic Usage

Para começar, você precisará adicionar o Provider do serviço na raiz do seu projeto React, com sua aplicação inteira sendo elemento filho do `B8SafeProvider` 

```js
import React from 'react';
import { B8SafeProvider } from 'react-native-b8safe';

const App = () => {
  return (
    <B8SafeProvider hashChecker="kvnDZt0331uPVxmW">
      {/* Aqui dentro vão todos os componentes do seu app e/ou sistema de navegação */}
    </B8SafeProvider>
  );
};

export default App;
```

O atributo `hashChecker` é obrigatório e pode ser obtido diretamente no painel [B8safe](https://safe.b8.com.br/login).

## Contributing

- See [this](https://arunkumarvallal.medium.com/-become-a-pro-at-commit-messages-using-commitlint-56dab86333b3) if you dont know to work with commitlint.
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## To-Do
- [ ] Concluir integração do webrtc;
- [ ] Criar tela de processamento;
- [ ] Criar tela de sucesso;
- [ ] Documentar passo a passo para instalação;
- [ ] Documentar passo a passo para a utilização da funcionalidade OCR;
- [ ] Documentar passo a passo para a utilização da funcionalidade Liveness (facial);
- [ ] Primeiros testes.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)