easyproctor 0.0.13 → 0.0.17

package/README.md

@@ -1,6 +1,6 @@
 # EasyProctor
 
-Modulo web do EasyProctor.
+O componente web EasyProctor permite que qualquer plataforma de execução de exames registre sessões de proctoring.
 
 ## Instalação
 
@@ -17,6 +17,18 @@ Via CDN
 
 ## Utilização
 
+Para utilizar o componente será necessário utilizar os seguintes parâmetros:
+- examId: identificador do exame
+- clientId: identificador do parceiro
+- token: token de autenticação biométrica (utilizar SDK biométrico do EasyProctor)
+
+Ao inicializar a sessão de proctoring através do método start do componente você receberá o objeto do tipo StartProctoringDTO que possui o identificador da sessão.
+
+Após finalizar a sessão de proctoring através do método finish você poderá consultar os dados de proctoring através da nossa API.
+
+https://iaris.easyproctor.tech/index.html
+
+
 Em um bundler
 ```javascript
 import { useProctoring } from "easyproctor";
@@ -98,7 +110,11 @@ const {
     // Finaliza a gravação da prova retornando os arquivos gerados
     finish, 
 
-} = useProctoring("cac34c6d-63ec-4f86-b5b0-bdeb52e8c146");
+} = useProctoring({
+            examId: "00001",
+            clientId: "000001",
+            token: "..."
+        });
 ```
 ## License
 [MIT](https://choosealicense.com/licenses/mit/)

package/dtos/AlertDTO.d.ts

@@ -0,0 +1,5 @@
+export default interface AlertDTO {
+    begin: number;
+    end: number;
+    alert: number;
+}

package/dtos/SaveScreenDTO.d.ts

@@ -0,0 +1,5 @@
+import AlertDTO from "./AlertDTO";
+export default interface SaveScreenDTO {
+    proctoringId: string;
+    alerts: AlertDTO[];
+}

package/esm/index.js

@@ -136,7 +136,7 @@ async function makeRequest(data) {
 }
 
 // src/index.ts
-var azureBlobUrl = "https://iarisprod.azureedge.net/iaris";
+var azureBlobUrl = "https://iarisprod.blob.core.windows.net/iaris";
 function useProctoring(proctoringOptions) {
   ["examId", "clientId", "token"].forEach((el) => {
     const key = el;
@@ -144,8 +144,6 @@ function useProctoring(proctoringOptions) {
       throw `O campo ${key} \xE9 obrigat\xF3rio`;
     }
   });
-  let focusCallback;
-  let lostFocusCallback;
   if (!navigator.mediaDevices.getDisplayMedia) {
     throw "Voc\xEA est\xE1 utilizando uma vers\xE3o muito antiga do navegador, por favor, atualize a vers\xE3o";
   }
@@ -165,6 +163,8 @@ function useProctoring(proctoringOptions) {
   let cameraBuffer = [];
   let screenBuffer = [];
   let proctoringId = "";
+  let startTime = 0;
+  let alerts = [];
   let cancelCallback = null;
   async function _startCapture() {
     if (!document.body) {
@@ -176,15 +176,7 @@ function useProctoring(proctoringOptions) {
     let cancelCameraCapture = null;
     let cancelScreenCapture = null;
     try {
-      if (focusCallback)
-        window.removeEventListener("focus", focusCallback);
-      if (lostFocusCallback)
-        window.removeEventListener("blur", lostFocusCallback);
       cancelScreenCapture = await startScreenCapture(screenBuffer);
-      if (focusCallback)
-        window.addEventListener("focus", () => window.addEventListener("focus", focusCallback), { once: true });
-      if (lostFocusCallback)
-        window.addEventListener("blur", lostFocusCallback);
       cancelCameraCapture = await startCameraCapture(cameraBuffer);
       cancelCallback = async function() {
         await Promise.all([cancelCameraCapture(), cancelScreenCapture()]);
@@ -198,6 +190,27 @@ function useProctoring(proctoringOptions) {
       throw "N\xE3o foi poss\xEDvel iniciar a captura, por favor, verifique as permiss\xF5es de camera e microfone";
     }
   }
+  const _onLostFocus = () => {
+    alerts.push({
+      begin: Date.now() - startTime,
+      alert: 25,
+      end: 0
+    });
+  };
+  const _onReturnFocus = () => {
+    const lastAlert = alerts[alerts.length - 1];
+    if (lastAlert) {
+      lastAlert.end = Date.now() - startTime;
+    }
+  };
+  const _addListeners = () => {
+    window.addEventListener("blur", _onLostFocus);
+    window.addEventListener("focus", _onReturnFocus);
+  };
+  const _removeListeners = () => {
+    window.removeEventListener("blur", _onLostFocus);
+    window.removeEventListener("focus", _onReturnFocus);
+  };
   async function start(options = { override: false }) {
     const { override } = options;
     if (override) {
@@ -209,6 +222,7 @@ function useProctoring(proctoringOptions) {
       }
     }
     await _startCapture();
+    startTime = Date.now();
     try {
       const resp = await makeRequest({
         url: `/proctoring/start/${proctoringOptions.examId}`,
@@ -217,18 +231,13 @@ function useProctoring(proctoringOptions) {
         jwt: proctoringOptions.token
       });
       proctoringId = resp.id;
+      _addListeners();
       return resp;
     } catch (error) {
       cancelCallback && cancelCallback();
       throw error;
     }
   }
-  async function pause() {
-    throw "Ainda n\xE3o implementado";
-  }
-  async function resume() {
-    throw "Ainda n\xE3o implementado";
-  }
   async function finish(options = {}) {
     const { onProgress } = options;
     if (cancelCallback) {
@@ -240,8 +249,8 @@ function useProctoring(proctoringOptions) {
     if (finalCameraBuffer.length == 0 || finalScreenBuffer.length == 0) {
       throw "N\xE3o existe nenhuma grava\xE7\xE3o iniciada";
     }
-    const cameraFileName = `EP_${proctoringOptions.examId}_${time}_camera_0.webm`;
-    const screenFIleName = `EP_${proctoringOptions.examId}_${time}_screen_0.webm`;
+    const cameraFileName = `EP_${proctoringId}_camera_0.webm`;
+    const screenFIleName = `EP_${proctoringId}_screen_0.webm`;
     const cameraFile = new File(finalCameraBuffer, cameraFileName, { type: "video/webm" });
     const screenFile = new File(finalScreenBuffer, screenFIleName, { type: "video/webm" });
     let cameraProgress = 0;
@@ -259,13 +268,14 @@ function useProctoring(proctoringOptions) {
         handleOnProgress();
       } })
     ]);
+    _removeListeners();
     await makeRequest({
       url: "/proctoring/save-screen",
       method: "POST",
       jwt: proctoringOptions.token,
       body: {
         proctoringId,
-        alerts: []
+        alerts: [...alerts]
       }
     });
     await makeRequest({
@@ -281,21 +291,10 @@ function useProctoring(proctoringOptions) {
     await Promise.all([clearBuffers("cameraBuffers"), clearBuffers("screenBuffers")]);
     cameraBuffer = [];
     screenBuffer = [];
+    alerts = [];
     cancelCallback = null;
   }
-  const onLostFocus = (cb) => {
-    lostFocusCallback = cb;
-    window.addEventListener("blur", lostFocusCallback);
-    const dispose = () => window.removeEventListener("blur", lostFocusCallback);
-    return dispose;
-  };
-  const onReturnFocus = (cb) => {
-    focusCallback = cb;
-    window.addEventListener("focus", focusCallback);
-    const dispose = () => window.removeEventListener("focus", focusCallback);
-    return dispose;
-  };
-  return { start, finish, pause, resume, onLostFocus, download, onReturnFocus };
+  return { start, finish, download };
 }
 if (typeof window !== "undefined") {
   window.useProctoring = useProctoring;

package/index.d.ts

@@ -10,9 +10,5 @@ export declare function useProctoring(proctoringOptions: {
     finish: (options?: {
         onProgress?: ((percentage: number) => void) | undefined;
     }) => Promise<void>;
-    pause: () => Promise<void>;
-    resume: () => Promise<void>;
-    onLostFocus: (cb: () => void) => () => void;
     download: (file: File) => void;
-    onReturnFocus: (cb: () => void) => () => void;
 };

package/index.js

@@ -166,7 +166,7 @@ async function makeRequest(data) {
 }
 
 // src/index.ts
-var azureBlobUrl = "https://iarisprod.azureedge.net/iaris";
+var azureBlobUrl = "https://iarisprod.blob.core.windows.net/iaris";
 function useProctoring(proctoringOptions) {
   ["examId", "clientId", "token"].forEach((el) => {
     const key = el;
@@ -174,8 +174,6 @@ function useProctoring(proctoringOptions) {
       throw `O campo ${key} \xE9 obrigat\xF3rio`;
     }
   });
-  let focusCallback;
-  let lostFocusCallback;
   if (!navigator.mediaDevices.getDisplayMedia) {
     throw "Voc\xEA est\xE1 utilizando uma vers\xE3o muito antiga do navegador, por favor, atualize a vers\xE3o";
   }
@@ -195,6 +193,8 @@ function useProctoring(proctoringOptions) {
   let cameraBuffer = [];
   let screenBuffer = [];
   let proctoringId = "";
+  let startTime = 0;
+  let alerts = [];
   let cancelCallback = null;
   async function _startCapture() {
     if (!document.body) {
@@ -206,15 +206,7 @@ function useProctoring(proctoringOptions) {
     let cancelCameraCapture = null;
     let cancelScreenCapture = null;
     try {
-      if (focusCallback)
-        window.removeEventListener("focus", focusCallback);
-      if (lostFocusCallback)
-        window.removeEventListener("blur", lostFocusCallback);
       cancelScreenCapture = await startScreenCapture(screenBuffer);
-      if (focusCallback)
-        window.addEventListener("focus", () => window.addEventListener("focus", focusCallback), { once: true });
-      if (lostFocusCallback)
-        window.addEventListener("blur", lostFocusCallback);
       cancelCameraCapture = await startCameraCapture(cameraBuffer);
       cancelCallback = async function() {
         await Promise.all([cancelCameraCapture(), cancelScreenCapture()]);
@@ -228,6 +220,27 @@ function useProctoring(proctoringOptions) {
       throw "N\xE3o foi poss\xEDvel iniciar a captura, por favor, verifique as permiss\xF5es de camera e microfone";
     }
   }
+  const _onLostFocus = () => {
+    alerts.push({
+      begin: Date.now() - startTime,
+      alert: 25,
+      end: 0
+    });
+  };
+  const _onReturnFocus = () => {
+    const lastAlert = alerts[alerts.length - 1];
+    if (lastAlert) {
+      lastAlert.end = Date.now() - startTime;
+    }
+  };
+  const _addListeners = () => {
+    window.addEventListener("blur", _onLostFocus);
+    window.addEventListener("focus", _onReturnFocus);
+  };
+  const _removeListeners = () => {
+    window.removeEventListener("blur", _onLostFocus);
+    window.removeEventListener("focus", _onReturnFocus);
+  };
   async function start(options = { override: false }) {
     const { override } = options;
     if (override) {
@@ -239,6 +252,7 @@ function useProctoring(proctoringOptions) {
       }
     }
     await _startCapture();
+    startTime = Date.now();
     try {
       const resp = await makeRequest({
         url: `/proctoring/start/${proctoringOptions.examId}`,
@@ -247,18 +261,13 @@ function useProctoring(proctoringOptions) {
         jwt: proctoringOptions.token
       });
       proctoringId = resp.id;
+      _addListeners();
       return resp;
     } catch (error) {
       cancelCallback && cancelCallback();
       throw error;
     }
   }
-  async function pause() {
-    throw "Ainda n\xE3o implementado";
-  }
-  async function resume() {
-    throw "Ainda n\xE3o implementado";
-  }
   async function finish(options = {}) {
     const { onProgress } = options;
     if (cancelCallback) {
@@ -270,8 +279,8 @@ function useProctoring(proctoringOptions) {
     if (finalCameraBuffer.length == 0 || finalScreenBuffer.length == 0) {
       throw "N\xE3o existe nenhuma grava\xE7\xE3o iniciada";
     }
-    const cameraFileName = `EP_${proctoringOptions.examId}_${time}_camera_0.webm`;
-    const screenFIleName = `EP_${proctoringOptions.examId}_${time}_screen_0.webm`;
+    const cameraFileName = `EP_${proctoringId}_camera_0.webm`;
+    const screenFIleName = `EP_${proctoringId}_screen_0.webm`;
     const cameraFile = new File(finalCameraBuffer, cameraFileName, { type: "video/webm" });
     const screenFile = new File(finalScreenBuffer, screenFIleName, { type: "video/webm" });
     let cameraProgress = 0;
@@ -289,13 +298,14 @@ function useProctoring(proctoringOptions) {
         handleOnProgress();
       } })
     ]);
+    _removeListeners();
     await makeRequest({
       url: "/proctoring/save-screen",
       method: "POST",
       jwt: proctoringOptions.token,
       body: {
         proctoringId,
-        alerts: []
+        alerts: [...alerts]
       }
     });
     await makeRequest({
@@ -311,21 +321,10 @@ function useProctoring(proctoringOptions) {
     await Promise.all([clearBuffers("cameraBuffers"), clearBuffers("screenBuffers")]);
     cameraBuffer = [];
     screenBuffer = [];
+    alerts = [];
     cancelCallback = null;
   }
-  const onLostFocus = (cb) => {
-    lostFocusCallback = cb;
-    window.addEventListener("blur", lostFocusCallback);
-    const dispose = () => window.removeEventListener("blur", lostFocusCallback);
-    return dispose;
-  };
-  const onReturnFocus = (cb) => {
-    focusCallback = cb;
-    window.addEventListener("focus", focusCallback);
-    const dispose = () => window.removeEventListener("focus", focusCallback);
-    return dispose;
-  };
-  return { start, finish, pause, resume, onLostFocus, download, onReturnFocus };
+  return { start, finish, download };
 }
 if (typeof window !== "undefined") {
   window.useProctoring = useProctoring;

package/package.json

@@ -1,35 +1,35 @@
-{
-  "name": "easyproctor",
-  "version": "0.0.13",
-  "description": "Modulo web de gravação do EasyProctor",
-  "main": "./index.js",
-  "module": "./esm/index.js",
-  "unpkg": "./unpkg/easyproctor.min.js",
-  "types": "./index.d.ts",
-  "keywords": [
-    "proctoring"
-  ],
-  "homepage": "https://vsoft1.visualstudio.com/DefaultCollection/Iaris/_git/easyproctor-proctoring-componentJs",
-  "repository": {
-    "type": "git",
-    "url": "https://vsoft1.visualstudio.com/DefaultCollection/Iaris/_git/easyproctor-proctoring-componentJs"
-  },
-  "scripts": {
-    "build": "node scripts/build.js && tsc",
-    "dev": "node scripts/serve.js -w"
-  },
-  "author": "Igor Dantas",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/dom-mediacapture-record": "^1.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.8.0",
-    "@typescript-eslint/parser": "^5.8.0",
-    "esbuild": "^0.13.13",
-    "esbuild-serve": "^1.0.1",
-    "eslint": "^8.2.0",
-    "typescript": "^4.5.4"
-  },
-  "dependencies": {
-    "@azure/storage-blob": "^12.8.0"
-  }
-}
+{
+  "name": "easyproctor",
+  "version": "0.0.17",
+  "description": "Modulo web de gravação do EasyProctor",
+  "main": "./index.js",
+  "module": "./esm/index.js",
+  "unpkg": "./unpkg/easyproctor.min.js",
+  "types": "./index.d.ts",
+  "keywords": [
+    "proctoring"
+  ],
+  "homepage": "https://vsoft1.visualstudio.com/DefaultCollection/Iaris/_git/easyproctor-proctoring-componentJs",
+  "repository": {
+    "type": "git",
+    "url": "https://vsoft1.visualstudio.com/DefaultCollection/Iaris/_git/easyproctor-proctoring-componentJs"
+  },
+  "scripts": {
+    "build": "node scripts/build.js && tsc",
+    "dev": "node scripts/serve.js -w"
+  },
+  "author": "Igor Dantas",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/dom-mediacapture-record": "^1.0.11",
+    "@typescript-eslint/eslint-plugin": "^5.8.0",
+    "@typescript-eslint/parser": "^5.8.0",
+    "esbuild": "^0.13.13",
+    "esbuild-serve": "^1.0.1",
+    "eslint": "^8.2.0",
+    "typescript": "^4.5.4"
+  },
+  "dependencies": {
+    "@azure/storage-blob": "^12.8.0"
+  }
+}