santoid-sdk 3.0.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Versão 3.0.1
+
+### Correções
+
+- Atualizações de estrutura na documentação para facilitar a leitura.
+
 ## Versão 3.0.0
 
 ### Mudanças

package/README.md

@@ -86,20 +86,21 @@ As propriedades disponíveis para utilização no objeto de opções estão list
 | token               | Token de acesso obtido por meio da autenticação. | Sim |
 | track               | Identificador do processo que será utilizado. | Sim |
 | customId            | Identificador customizado para auditoria. | Não |
-| startGettingFrames  | Função executada quando a obtenção de frames for iniciada. <br>Se retornar um valor do tipo MediaStream, ele será salvo e fornecido <br>por meio da função **getVideoStream**. | Não |
-| getNextFrame        | Função que deve retornar os frames no formato **File ou Blob**. <br>Será executada várias vezes e deve sempre devolver o próximo frame. | Não |
+| startGettingFrames  | Função executada quando a obtenção de frames for iniciada. <br><br>Se retornar um valor do tipo MediaStream, ele será salvo e fornecido por meio da função **getVideoStream**. | Não |
+| getNextFrame        | Função que deve retornar os frames no formato **File ou Blob**. <br><br>Será executada várias vezes e deve sempre devolver o próximo frame. | Não |
 | stopGettingFrames   | Função executada quando a obtenção de frames for finalizada. | Não | 
-| onStart             | Função executada quando a verificação for iniciada. <br>Disponibiliza pelos parâmetros um objeto contendo a stream da <br>transmissão (**videoStream**), caso disponível. | Não |
-| onNextStep          | Função executada sempre que a validação muda para a próxima etapa. <br>Disponibiliza pelos parâmetros a etapa atual ('front', 'left', 'right', 'up' ou 'bottom'). | Não |
+| onStart             | Função executada quando a verificação for iniciada. <br><br>Disponibiliza pelos parâmetros um objeto contendo a stream da transmissão (**videoStream**), caso disponível. | Não |
+| onNextStep          | Função executada sempre que a validação muda para a próxima etapa. <br><br>Disponibiliza pelos parâmetros a etapa atual ('front', 'left', 'right', 'up' ou 'bottom'). | Não |
 | onFrontStep         | Função executada quando a etapa 'front' é iniciada. | Não |
 | onLeftStep          | Função executada quando a etapa 'left' é iniciada. | Não |
 | onRightStep         | Função executada quando a etapa 'right' é iniciada. | Não |
 | onUpStep            | Função executada quando a etapa 'up' é iniciada. | Não |
 | onBottomStep        | Função executada quando a etapa 'bottom' é iniciada. | Não |
-| onError             | Função executada quando ocorre um erro. <br>Disponibiliza pelos parâmetros a instância do erro, a qual <br>contém um identificador (propriedade **code**). | Não |
-| onSuccess           | Função executada quando a verificação é finalizada com sucesso. <br>Disponibiliza pelos parâmetros um objeto com os resultados, compostos <br>pelo ID da solicitação (**livenessId**) <br>e pelos frames de sucesso (**successFrames**). | Não |
+| onError             | Função executada quando ocorre um erro. <br><br>Disponibiliza pelos parâmetros a instância do erro, a qual contém um identificador (propriedade **code**). | Não |
+| onSuccess           | Função executada quando a verificação é finalizada com sucesso. <br><br>Disponibiliza pelos parâmetros um objeto com os resultados, compostos pelo ID da solicitação (**livenessId**) e pelos frames de sucesso (**successFrames**). | Não |
 | onEnd               | Função executada quando a verificação é finalizada, seja com erro ou com sucesso. | Não |
 
+<br>
 Caso a função seja executada em um navegador (ou ambiente semelhante que utilize JavaScript, como o WebView, por exemplo), não é obrigatório fornecer uma função que retorne os frames para verificação (getNextFrame), pois o próprio SDK iniciará a câmera e realizará todo o processo caso a função não seja fornecida.
 
 #### Retorno da função livenessDetection (JavaScript)
@@ -112,6 +113,8 @@ A função livenessDetection retorna alguns métodos que possibilitam um melhor
 | pauseGettingFrames | Para a verificação temporariamente, a qual pode ser retomada posteriormente. |
 | resumeGettingFrames | Retoma a verificação, caso ela tenha sido pausada com a função pauseGettingFrames. |
 
+<br>
+
 ```ts
 import { livenessDetection } from 'santoid-sdk/liveness'
 
@@ -141,7 +144,7 @@ const { getVideoStream, stopLivenessDetection, pauseGettingFrames, resumeGetting
 
 ```
 #### Utilização em Node.js
-Caso deseje executar a função da prova de vida no servidor (Node.js), **é obrigatório informar ao SDK a função de obtenção de frames** (getNextFrame), a qual deve retornar um Buffer ou semelhante (string, ArrayBuffer, Buffer ou Buffer[]) contendo os dados da imagem do frame.
+Caso deseje executar a função da prova de vida no servidor (Node.js), **é obrigatório informar ao SDK a função de obtenção de frames** (getNextFrame), a qual deve retornar um valor no formato **string, ArrayBuffer, Buffer ou Buffer[]** contendo os dados da imagem do frame.
 
 Fique atento ao caminho de importação da função, que muda para o caso de execução no servidor (Node.js):
 
@@ -151,7 +154,9 @@ Para Node.js, as opções são quase as mesmas que as utilizadas em JavaScript,
 | Nome da propriedade | Função | É obrigatório? |
 | ------------------- | ------ | -------------- |
 | startGettingFrames  | Função executada quando a obtenção de frames for iniciada. <br>Não precisa retornar nenhum valor. | Não |
-| getNextFrame        | Função que deve retornar os frames no formato **Buffer ou semelhante (string, ArrayBuffer, Buffer ou Buffer[])**. <br>Será executada várias vezes e deve sempre devolver o próximo frame. | Sim |
+| getNextFrame        | Função que deve retornar os frames no formato **string, ArrayBuffer, Buffer ou Buffer[]**. <br><br>Será executada várias vezes e deve sempre devolver o próximo frame. | Sim |
+
+<br>
 
 #### Retorno da função livenessDetection (Node.js)
 Os itens retornados pela função livenessDetection para Node.js são semelhantes àos retornados pela função para JavaScript, com exceção da função **getVideoStream**, que não é retornada.
@@ -224,11 +229,13 @@ As propriedades disponíveis para utilização no objeto de opções estão list
 | token               | Token de acesso obtido por meio da autenticação. | Sim |
 | track               | Identificador do processo que será utilizado. | Sim |
 | livenessDetectionOptions | Opções para a verificação de prova de vida. | Não |
-| onUpdate            | Função executada toda vez que ocorre uma atualização no status geral <br>(quando alguma operação é iniciada ou concluída, quando ocorre erro, etc.). <br>Disponibiliza pelos parâmetros um objeto contendo as informações sobre a <br>situação de cada tipo de processamento realizado (envio de documento, prova de vida, etc.). | Não |
+| onUpdate            | Função executada toda vez que ocorre uma atualização no status geral (quando alguma operação é iniciada ou concluída, quando ocorre erro, etc.). <br><br>Disponibiliza pelos parâmetros um objeto contendo as informações sobre a situação de cada tipo de processamento realizado (envio de documento, prova de vida, etc.). | Não |
 | onError             | Função executada quando ocorre erro em alguma das operações. | Não |
-| onSuccess           | Função executada quando as verificações são finalizadas com sucesso. | Não |
+| onSuccess           | Função executada quando as verificações são finalizadas com sucesso. <br><br>Disponibiliza pelos parâmetros o mesmo objeto fornecido pela função onUpdate, porém com todos os resultados preenchidos. | Não |
 | onEnd               | Função executada quando a verificação é finalizada, seja com erro ou com sucesso. | Não |
 
+<br>
+
 ```ts
 import { uploadIdentificationDocument } from 'santoid-sdk/liveness'
 
@@ -281,12 +288,14 @@ A função uploadIdentificationDocument retorna alguns métodos que podem ser ut
 
 | Nome da propriedade | Função |
 | ------------------- | ------ |
-| startAll | Inicia todas as análises simultaneamente e espera dois parâmetros: o arquivo do documento (no formato **Blob** ou **File**) e, <br>opcionalmente, as configurações para a prova de vida (caso deseje sobrescrevê-las). |
+| startAll | Inicia todas as análises simultaneamente e espera dois parâmetros: o arquivo do documento (no formato **Blob** ou **File**) e, opcionalmente, as configurações para a prova de vida (caso deseje sobrescrevê-las). |
 | startDocumentUpload | Inicia a etapa de upload/análise do documento que será enviado e espera receber um parâmetro com o arquivo. (no formato **Blob** ou **File**). |
 | startLivenessDetection | Inicia a verificação de prova de vida e aceita as mesmas opções que a função livenessDetection, caso deseje sobrescrevê-las. |
-| startFaceComparison | Inicia a comparação da face do documento com a face detectada na prova de vida. <br>Ela será iniciada automaticamente quando as outras análises forem concluídas, <br>porém você pode usar essa função para fazer uma nova tentativa em caso de falha. |
+| startFaceComparison | Inicia a comparação da face do documento com a face detectada na prova de vida. <br><br>Ela será iniciada automaticamente quando as outras análises forem concluídas, porém você pode usar essa função para fazer uma nova tentativa em caso de falha. |
 | getResults | Retorna os status atuais de cada análise, no formato apresentado abaixo. |
 
+<br>
+
 #### Formato dos resultados da função uploadIdentificationDocument
 ```typescript
 interface IUploadIdentificationDocumentResults {
@@ -387,8 +396,7 @@ interface IFaceMatchResult {
 De forma semelhante à funcionalidade da Prova de Vida, para o Node.js o caminho da importação muda
 e a função **getNextFrame** passa a ser obrigatória e deve ser fornecida às opções para o livenessDetection.
 
-Outro detalhe é que no Node.js todos os tipos envolvendo **File** ou **Blob** passam a utilizar **Buffers**
-ou outros tipos equivalentes (string, ArrayBuffer, Buffer ou Buffer[]).
+Outro detalhe é que no Node.js todos os tipos envolvendo **File** ou **Blob** passam a utilizar valores do tipo **string, ArrayBuffer, Buffer ou Buffer[]**.
 
 Todos as outras opções e retornos se mantém os mesmos da versão para JavaScript.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "santoid-sdk",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "",
   "main": "liveness/index.js",
   "types": "liveness/index.d.ts",