easyproctor 1.1.16 → 2.0.0

package/README.md

@@ -35,7 +35,22 @@ Em um bundler
 ```javascript
 import { useProctoring } from "easyproctor";
 
-const { start, finish, pause, resume, onFocus, onLostFocus, enumarateDevices, checkPermissions, checkIfhasMultipleMonitors, onStopSharingScreen } = useProctoring({
+const {
+  login,
+  start,
+  finish,
+  checkDevices,
+  capturePhoto,
+  checkPermissions,
+  enumarateDevices,
+  checkIfhasMultipleMonitors,
+  onFocus,
+  onLostFocus,
+  onChangeDevices,
+  onRealtimeAlerts,
+  onBufferSizeError,
+  onStopSharingScreen,
+} = useProctoring({
   examId: "00001",
   clientId: "000001",
   token: "...",
@@ -47,11 +62,26 @@ Via CDN: A função "useProctoring" é injetada para ser utilizada globalmente
 ```html
 <script src="https://cdn.jsdelivr.net/npm/easyproctor/unpkg/easyproctor.min.js"></script>
 <script>
-  const { start, finish, pause, resume, onFocus, onLostFocus, enumarateDevices, checkPermissions, checkIfhasMultipleMonitors, onStopSharingScreen } = useProctoring({
-    examId: "00001",
-    clientId: "000001",
-    token: "...",
-  });
+const {
+  login,
+  start,
+  finish,
+  checkDevices,
+  capturePhoto,
+  checkPermissions,
+  enumarateDevices,
+  checkIfhasMultipleMonitors,
+  onFocus,
+  onLostFocus,
+  onChangeDevices,
+  onRealtimeAlerts,
+  onBufferSizeError,
+  onStopSharingScreen,
+} = useProctoring({
+  examId: "00001",
+  clientId: "000001",
+  token: "...",
+});
 </script>
 ```
 
@@ -67,14 +97,22 @@ Via CDN: A função "useProctoring" é injetada para ser utilizada globalmente
     <title>Document</title>
     <script src="dist/unpkg/easyproctor.min.js"></script>
     <script>
-      const {
+    const {
+        login,
         start,
         finish,
+        checkDevices,
+        capturePhoto,
+        checkPermissions,
+        enumarateDevices,
+        checkIfhasMultipleMonitors,
         onFocus,
         onLostFocus,
-        enumarateDevices,
-        checkPermissions,
-      } = useProctoring({
+        onChangeDevices,
+        onRealtimeAlerts,
+        onBufferSizeError,
+        onStopSharingScreen
+    } = useProctoring({
         examId: "00001",
         clientId: "000001",
         token: "...",
@@ -184,34 +222,41 @@ const {
   // Inicia a gravação da prova
   start,
 
-  // Pausa a gravação
-  pause,
-
-  // Reinicia a gravação
-  resume,
-
   // Finaliza a gravação da prova retornando os arquivos gerados
   finish,
 
   // Adiciona uma função callback para ser executada quando o usuário recupera o foco da tela
   onFocus,
 
+  // Adiciona uma função de callback para ser executada quando ...
+  onBufferSizeError,
+
+  // Adiciona um função de callback para ser executada quando o usuário altera os dispositivos
+  onChangeDevices,
+
   // Adiciona uma função callback para ser executada quando o usuário perde o foco da tela
   onLostFocus,
 
+  // Adiciona uma função de callback para ser executada quando ocorrem alertas durante o exame
+  onRealtimeAlerts,
+
   // Adiciona uma função callback para ser executada quando o usuário cancela o compartilhamento de tela
   onStopSharingScreen
 
-  // Enumera os dispositivos de camera e microfone
-  enumarateDevices,
+  // Realiza uma captura de foto do usuário e a utiliza para fazer o resgistro ou login biométrico.
+  capturePhoto
 
-  // Checa as permissões de camera e microfone
-  checkPermissions,
+  // Checa se os dispositivos (câmera, microfone, stream da tela) estão funcionando corretamente
+  checkDevices,
 
   // Checa se existe mais de um monitor
-  checkIfhasMultipleMonitors
+  checkIfhasMultipleMonitors,
 
-  
+  // Checa as permissões de camera e microfone
+  checkPermissions,
+
+  // Enumera os dispositivos de camera e microfone
+  enumarateDevices,
 } = useProctoring({
   examId: "00001",
   clientId: "000001",
@@ -219,9 +264,60 @@ const {
 });
 ```
 
+## Release Note V 2.0.0
+- Remoção do script deprecated AudioProcessor
+- Monitoramento ativo durante o exame
+  - Novos tipos de alertas do onRealtimeAlerts:
+    - audio_detection_on_stream
+    - face_detection_on_stream
+    - mobile_detection_on_stream
+    - person_detection_on_stream
+    - position_detection_on_stream
+- Nova forma de gravação de áudio
+- Remoção das funções `pause()` e `resume()`
+- Análise de posicionamento da face no modal do `checkDevices()`
+- Novas propriedades adicionadas no retorno do `checkDevices()`:
+
+```ts
+{
+    allowedPositionFace: boolean,
+    allowedMicrophone: boolean,
+    allowedPositionFace: boolean,
+    allowedResolution: boolean,
+    cameraId: string,
+    michophoneId: string,
+    volumeRange: number,
+    faceDetectionAlerts: { status: 'OK' | 'ALERT', type: string, description?: string },
+    result: boolean,
+}
+```
+
+## Release Note V 1.1.6
+
+- - Adiciona o botão de cancelar captura no `capturePhoto()`.
+  - Se a captura for cancelada, ela lancará uma exceção.
+
+## Release Note V 1.1.5
+
+- Captura da Geolocalização
+- Login via componente (Credentials)
+- Bloquear navegadores sem suporte
+- Bloquear exame quando camera estiver em uso
+- Gravação de vídeo opcional
+- Atualização Interface do CapturePhoto
+- Criação do callback onBufferSizeError
+- Criação do callback onRealtimeAlerts
+- Bloqueio das cameras simuladas da listagem de devices
+- Aviso de camera ocupada
+
+## Release Note V 1.1.4
+
+- Adicionado resolução de 480p na gravação da tela
+- Melhorias no finish
+
 ## Release Note V 1.1.0
 
-- Adicionado fotos durante a execução da prova 
+- Adicionado fotos durante a execução da prova
 - Adicionado o modal de capturePhoto, para cadastramento e autenticação biométrica
 - Correção de interface do modal checkDevices com problema no lts