easyproctor 2.1.0 → 2.1.1

package/README.md

@@ -263,6 +263,10 @@ const {
   token: "...",
 });
 ```
+## Release Note V 2.1.1
+- Escolha automatica do codec suportado (vp8/vp9)
+- Não é mais obrigatório passar width e height no check devices
+- Melhorias nos logs
 
 ## Release Note V 2.1.0
 - Criação do runCheckDevicesFlow que permite que o usuário receba a lógica do checkDevices() em um modal próprio

package/esm/index.js

@@ -4537,6 +4537,12 @@ function validatePartialVideoOptions(options) {
     return { width: 640, height: 480 };
   }
 }
+var getDefaultProctoringVideoOptions = {
+  width: 1280,
+  height: 720,
+  minWidth: 640,
+  minHeight: 480
+};
 
 // node_modules/axios/lib/helpers/bind.js
 function bind(fn3, thisArg) {
@@ -6818,9 +6824,11 @@ var eventNames = {
   FINISH: "finish",
   ERROR: "error",
   UPLOAD_VIDEO: "upload_video",
+  DOWNLOAD_VIDEO: "download_video",
   BUFFER_SIZE: "buffer_size",
   ANOTHER_STREAM: "another_stream",
-  BROWSER_NOT_SUPPORTED: "browser_not_supported"
+  BROWSER_NOT_SUPPORTED: "browser_not_supported",
+  SAVE_ON_SESSION: "save_on_session"
 };
 var log = (eventName, properties) => backendService && backendService.log(eventName, properties);
 var trackers = {
@@ -6833,8 +6841,10 @@ var trackers = {
   registerChangeDevice: (proctoringId, inOrOut, devicesChanged) => log(eventNames.UPLOAD_VIDEO, { proctoringId, inOrOut, devicesChanged }),
   registerStopSharingScreen: (proctoringId, description) => log(eventNames.UPLOAD_VIDEO, { proctoringId, description }),
   registerErrorRecorderRTC: (proctoringId, description) => log(eventNames.UPLOAD_VIDEO, { proctoringId, description }),
+  registerDownloadFile: (proctoringId, description) => log(eventNames.DOWNLOAD_VIDEO, { proctoringId, description }),
   registerOnBufferSizeError: (proctoringId, description) => log(eventNames.BUFFER_SIZE, { proctoringId, description }),
-  registerAnotherStream: (proctoringId, description) => log(eventNames.ANOTHER_STREAM, { proctoringId, description })
+  registerAnotherStream: (proctoringId, description) => log(eventNames.ANOTHER_STREAM, { proctoringId, description }),
+  registerSaveOnSession: (proctoringId, description) => log(eventNames.SAVE_ON_SESSION, { proctoringId, description })
 };
 
 // src/plugins/recorder.ts
@@ -6843,11 +6853,18 @@ function recorder(stream, buffer, proctoringId, onBufferSizeError = false, onBuf
   let stopped = false;
   let onBufferSizeInterval;
   let lastEvent;
+  let bufferSize;
+  bufferSize = 0;
   let options = {
     mimeType: "video/webm",
     videoBitsPerSecond: 128e3,
     audioBitsPerSecond: 64 * 1e3
   };
+  if (MediaRecorder.isTypeSupported("video/webm;codecs=vp9")) {
+    options.mimeType = "video/webm;codecs=vp9";
+  } else {
+    console.warn("vp9 codec not supported. Using default mimeType without vp9.");
+  }
   if (audio) {
     options = {
       mimeType: "audio/webm",
@@ -6856,6 +6873,7 @@ function recorder(stream, buffer, proctoringId, onBufferSizeError = false, onBuf
   }
   const mediaRecorder = new MediaRecorder(stream, options);
   mediaRecorder.ondataavailable = (e3) => {
+    bufferSize = bufferSize + e3.data.size;
     if (e3.data.size > 0) {
       buffer.push(e3.data);
     }
@@ -6878,6 +6896,7 @@ function recorder(stream, buffer, proctoringId, onBufferSizeError = false, onBuf
     return new Promise((resolve) => {
       resolvePromise = resolve;
       mediaRecorder.start();
+      bufferSize = 0;
       stopped = false;
       if (onBufferSizeError) {
         onBufferSizeInterval = setInterval(async () => {
@@ -6921,7 +6940,10 @@ function recorder(stream, buffer, proctoringId, onBufferSizeError = false, onBuf
       }
     });
   }
-  return { startRecording, stopRecording, pauseRecording, resumeRecording };
+  function getBufferSize() {
+    return bufferSize;
+  }
+  return { startRecording, stopRecording, pauseRecording, resumeRecording, options, getBufferSize };
 }
 
 // src/new-flow/upload/UploadService.ts
@@ -7301,11 +7323,13 @@ var CameraRecorder = class {
         throw "N\xE3o foi poss\xEDvel conectar a camera, ela pode estar sendo utilizada por outro programa";
       throw error;
     }
-    const { startRecording, stopRecording, pauseRecording, resumeRecording } = recorder(this.cameraStream, this.blobs, this.proctoringId, this.options.onBufferSizeError, onBufferSizeErrorCallback);
+    const { startRecording, stopRecording, pauseRecording, resumeRecording, options, getBufferSize } = recorder(this.cameraStream, this.blobs, this.proctoringId, this.options.onBufferSizeError, onBufferSizeErrorCallback);
     this.recordingStart = startRecording;
     this.recordingStop = stopRecording;
     this.recordingPause = pauseRecording;
     this.recordingResume = resumeRecording;
+    this.recorderOptions = options;
+    this.getBufferSize = getBufferSize;
     this.recordingStart();
     const tracks = this.cameraStream.getVideoTracks();
     const settings = tracks[0].getSettings();
@@ -7313,8 +7337,8 @@ var CameraRecorder = class {
       throw STREAM_UNDER_MINIMUM_PERMITTED;
     } else if (this.videoOptions.width !== settings.width || this.videoOptions.height !== settings.height) {
       trackers.registerAnotherStream(this.proctoringId, `Maybe have another stream active
-Video Options: ${this.videoOptions}
-Setting: ${settings}`);
+Video Options: ${JSON.stringify(this.videoOptions, null, 2)}
+Setting: ${JSON.stringify(settings, null, 2)}`);
       throw ANOTHER_STREAM_ACTIVE;
     }
     ((_d = this.paramsConfig.imageBehaviourParameters) == null ? void 0 : _d.useUploadImage) && this.options.proctoringType == "IMAGE" && this.photoShotsCycle();
@@ -7459,16 +7483,21 @@ Setting: ${settings}`);
     window.URL.revokeObjectURL(url);
   }
   async saveOnSession(session) {
-    var _a2;
+    var _a2, _b;
+    if (this.blobs != null)
+      trackers.registerSaveOnSession(this.proctoringId, `Blobs Length: ${this.blobs.length} Buffer Size: ${this.getBufferSize()} `);
     const settings = this.cameraStream.getVideoTracks()[0].getSettings();
     const settingsAudio = this.cameraStream.getAudioTracks()[0].getSettings();
     if (this.options.proctoringType == "VIDEO" || this.options.proctoringType == "REALTIME" || this.options.proctoringType == "IMAGE" && ((_a2 = this.paramsConfig.imageBehaviourParameters) == null ? void 0 : _a2.saveVideo)) {
       session.addRecording({
         device: `Audio
 	Sample Rate: ${settingsAudio.sampleRate}
-	Sample Size: ${settingsAudio.sampleSize}`,
+	Sample Size: ${settingsAudio.sampleSize}
+
+	Video:
+	${JSON.stringify(this.recorderOptions)}`,
         file: new File(this.blobs, `EP_${session.id}_camera_0.webm`, {
-          type: "video/webm"
+          type: ((_b = this.recorderOptions) == null ? void 0 : _b.mimeType) || "video/webm"
         }),
         origin: "Camera" /* Camera */
       });
@@ -8286,7 +8315,7 @@ var _DeviceCheckerService = class {
       });
     }
   }
-  async checkDevices(options = getDefaultProctoringOptions, _videoOptions) {
+  async checkDevices(options = getDefaultProctoringOptions, _videoOptions = getDefaultProctoringVideoOptions) {
     var _a2;
     if (_DeviceCheckerService.isModalOpen) {
       return Promise.reject();
@@ -8858,13 +8887,21 @@ var DownloadService = class {
     this.proctoringId = proctoringId;
   }
   async upload(data, token) {
+    const { file, onProgress } = data;
     try {
-      const { file, onProgress } = data;
+      trackers.registerDownloadFile(this.proctoringId, `File to download
+	File name: ${file.name}
+	File type: ${file.type}
+	File size: ${file.size}}`);
       (0, import_file_saver.saveAs)(file);
       this.loadingBoolean = false;
       clearInterval(this.loadingInterval);
       onProgress && onProgress(Math.round(100));
     } catch (err) {
+      file && this.proctoringId && trackers.registerError(this.proctoringId, `Failed on machine download
+	File name: ${file.name}
+	File type: ${file.type}
+	File size: ${file.size}`);
       throw new Error(`Error on machine download`);
     }
   }
@@ -12162,13 +12199,15 @@ Upload Services: ${uploaderServices}`,
           this.serviceType
         );
       }
-      await this.backend.saveScreenAlerts(this.context, this.proctoringSession).catch((err) => {
-        trackers.registerFinish(
-          this.proctoringSession.id,
-          false,
-          "save-screen error: " + err
-        );
-      });
+      if (this.proctoringSession.alerts.length > 0) {
+        await this.backend.saveScreenAlerts(this.context, this.proctoringSession).catch((err) => {
+          trackers.registerFinish(
+            this.proctoringSession.id,
+            false,
+            "save-screen error: " + err
+          );
+        });
+      }
       await this.backend.finishAndSendUrls(this.context, this.proctoringSession).then(() => {
         trackers.registerFinish(this.proctoringSession.id, true, "");
       }).catch((error) => {

package/index.js

@@ -15240,6 +15240,12 @@ function validatePartialVideoOptions(options) {
     return { width: 640, height: 480 };
   }
 }
+var getDefaultProctoringVideoOptions = {
+  width: 1280,
+  height: 720,
+  minWidth: 640,
+  minHeight: 480
+};
 
 // node_modules/axios/lib/helpers/bind.js
 function bind(fn3, thisArg) {
@@ -18349,9 +18355,11 @@ var eventNames = {
   FINISH: "finish",
   ERROR: "error",
   UPLOAD_VIDEO: "upload_video",
+  DOWNLOAD_VIDEO: "download_video",
   BUFFER_SIZE: "buffer_size",
   ANOTHER_STREAM: "another_stream",
-  BROWSER_NOT_SUPPORTED: "browser_not_supported"
+  BROWSER_NOT_SUPPORTED: "browser_not_supported",
+  SAVE_ON_SESSION: "save_on_session"
 };
 var log = (eventName, properties) => backendService && backendService.log(eventName, properties);
 var trackers = {
@@ -18364,8 +18372,10 @@ var trackers = {
   registerChangeDevice: (proctoringId, inOrOut, devicesChanged) => log(eventNames.UPLOAD_VIDEO, { proctoringId, inOrOut, devicesChanged }),
   registerStopSharingScreen: (proctoringId, description) => log(eventNames.UPLOAD_VIDEO, { proctoringId, description }),
   registerErrorRecorderRTC: (proctoringId, description) => log(eventNames.UPLOAD_VIDEO, { proctoringId, description }),
+  registerDownloadFile: (proctoringId, description) => log(eventNames.DOWNLOAD_VIDEO, { proctoringId, description }),
   registerOnBufferSizeError: (proctoringId, description) => log(eventNames.BUFFER_SIZE, { proctoringId, description }),
-  registerAnotherStream: (proctoringId, description) => log(eventNames.ANOTHER_STREAM, { proctoringId, description })
+  registerAnotherStream: (proctoringId, description) => log(eventNames.ANOTHER_STREAM, { proctoringId, description }),
+  registerSaveOnSession: (proctoringId, description) => log(eventNames.SAVE_ON_SESSION, { proctoringId, description })
 };
 
 // src/plugins/recorder.ts
@@ -18374,11 +18384,18 @@ function recorder(stream4, buffer, proctoringId, onBufferSizeError = false, onBu
   let stopped = false;
   let onBufferSizeInterval;
   let lastEvent;
+  let bufferSize;
+  bufferSize = 0;
   let options = {
     mimeType: "video/webm",
     videoBitsPerSecond: 128e3,
     audioBitsPerSecond: 64 * 1e3
   };
+  if (MediaRecorder.isTypeSupported("video/webm;codecs=vp9")) {
+    options.mimeType = "video/webm;codecs=vp9";
+  } else {
+    console.warn("vp9 codec not supported. Using default mimeType without vp9.");
+  }
   if (audio) {
     options = {
       mimeType: "audio/webm",
@@ -18387,6 +18404,7 @@ function recorder(stream4, buffer, proctoringId, onBufferSizeError = false, onBu
   }
   const mediaRecorder = new MediaRecorder(stream4, options);
   mediaRecorder.ondataavailable = (e3) => {
+    bufferSize = bufferSize + e3.data.size;
     if (e3.data.size > 0) {
       buffer.push(e3.data);
     }
@@ -18409,6 +18427,7 @@ function recorder(stream4, buffer, proctoringId, onBufferSizeError = false, onBu
     return new Promise((resolve) => {
       resolvePromise = resolve;
       mediaRecorder.start();
+      bufferSize = 0;
       stopped = false;
       if (onBufferSizeError) {
         onBufferSizeInterval = setInterval(async () => {
@@ -18452,7 +18471,10 @@ function recorder(stream4, buffer, proctoringId, onBufferSizeError = false, onBu
       }
     });
   }
-  return { startRecording, stopRecording, pauseRecording, resumeRecording };
+  function getBufferSize() {
+    return bufferSize;
+  }
+  return { startRecording, stopRecording, pauseRecording, resumeRecording, options, getBufferSize };
 }
 
 // src/new-flow/upload/UploadService.ts
@@ -18832,11 +18854,13 @@ var CameraRecorder = class {
         throw "N\xE3o foi poss\xEDvel conectar a camera, ela pode estar sendo utilizada por outro programa";
       throw error;
     }
-    const { startRecording, stopRecording, pauseRecording, resumeRecording } = recorder(this.cameraStream, this.blobs, this.proctoringId, this.options.onBufferSizeError, onBufferSizeErrorCallback);
+    const { startRecording, stopRecording, pauseRecording, resumeRecording, options, getBufferSize } = recorder(this.cameraStream, this.blobs, this.proctoringId, this.options.onBufferSizeError, onBufferSizeErrorCallback);
     this.recordingStart = startRecording;
     this.recordingStop = stopRecording;
     this.recordingPause = pauseRecording;
     this.recordingResume = resumeRecording;
+    this.recorderOptions = options;
+    this.getBufferSize = getBufferSize;
     this.recordingStart();
     const tracks = this.cameraStream.getVideoTracks();
     const settings = tracks[0].getSettings();
@@ -18844,8 +18868,8 @@ var CameraRecorder = class {
       throw STREAM_UNDER_MINIMUM_PERMITTED;
     } else if (this.videoOptions.width !== settings.width || this.videoOptions.height !== settings.height) {
       trackers.registerAnotherStream(this.proctoringId, `Maybe have another stream active
-Video Options: ${this.videoOptions}
-Setting: ${settings}`);
+Video Options: ${JSON.stringify(this.videoOptions, null, 2)}
+Setting: ${JSON.stringify(settings, null, 2)}`);
       throw ANOTHER_STREAM_ACTIVE;
     }
     ((_d = this.paramsConfig.imageBehaviourParameters) == null ? void 0 : _d.useUploadImage) && this.options.proctoringType == "IMAGE" && this.photoShotsCycle();
@@ -18990,16 +19014,21 @@ Setting: ${settings}`);
     window.URL.revokeObjectURL(url2);
   }
   async saveOnSession(session) {
-    var _a2;
+    var _a2, _b;
+    if (this.blobs != null)
+      trackers.registerSaveOnSession(this.proctoringId, `Blobs Length: ${this.blobs.length} Buffer Size: ${this.getBufferSize()} `);
     const settings = this.cameraStream.getVideoTracks()[0].getSettings();
     const settingsAudio = this.cameraStream.getAudioTracks()[0].getSettings();
     if (this.options.proctoringType == "VIDEO" || this.options.proctoringType == "REALTIME" || this.options.proctoringType == "IMAGE" && ((_a2 = this.paramsConfig.imageBehaviourParameters) == null ? void 0 : _a2.saveVideo)) {
       session.addRecording({
         device: `Audio
 	Sample Rate: ${settingsAudio.sampleRate}
-	Sample Size: ${settingsAudio.sampleSize}`,
+	Sample Size: ${settingsAudio.sampleSize}
+
+	Video:
+	${JSON.stringify(this.recorderOptions)}`,
         file: new File(this.blobs, `EP_${session.id}_camera_0.webm`, {
-          type: "video/webm"
+          type: ((_b = this.recorderOptions) == null ? void 0 : _b.mimeType) || "video/webm"
         }),
         origin: "Camera" /* Camera */
       });
@@ -19817,7 +19846,7 @@ var _DeviceCheckerService = class {
       });
     }
   }
-  async checkDevices(options = getDefaultProctoringOptions, _videoOptions) {
+  async checkDevices(options = getDefaultProctoringOptions, _videoOptions = getDefaultProctoringVideoOptions) {
     var _a2;
     if (_DeviceCheckerService.isModalOpen) {
       return Promise.reject();
@@ -20389,13 +20418,21 @@ var DownloadService = class {
     this.proctoringId = proctoringId;
   }
   async upload(data, token) {
+    const { file, onProgress } = data;
     try {
-      const { file, onProgress } = data;
+      trackers.registerDownloadFile(this.proctoringId, `File to download
+	File name: ${file.name}
+	File type: ${file.type}
+	File size: ${file.size}}`);
       (0, import_file_saver.saveAs)(file);
       this.loadingBoolean = false;
       clearInterval(this.loadingInterval);
       onProgress && onProgress(Math.round(100));
     } catch (err) {
+      file && this.proctoringId && trackers.registerError(this.proctoringId, `Failed on machine download
+	File name: ${file.name}
+	File type: ${file.type}
+	File size: ${file.size}`);
       throw new Error(`Error on machine download`);
     }
   }
@@ -23693,13 +23730,15 @@ Upload Services: ${uploaderServices}`,
           this.serviceType
         );
       }
-      await this.backend.saveScreenAlerts(this.context, this.proctoringSession).catch((err) => {
-        trackers.registerFinish(
-          this.proctoringSession.id,
-          false,
-          "save-screen error: " + err
-        );
-      });
+      if (this.proctoringSession.alerts.length > 0) {
+        await this.backend.saveScreenAlerts(this.context, this.proctoringSession).catch((err) => {
+          trackers.registerFinish(
+            this.proctoringSession.id,
+            false,
+            "save-screen error: " + err
+          );
+        });
+      }
       await this.backend.finishAndSendUrls(this.context, this.proctoringSession).then(() => {
         trackers.registerFinish(this.proctoringSession.id, true, "");
       }).catch((error) => {

package/new-flow/checkers/DeviceCheckerService.d.ts

@@ -39,7 +39,7 @@ export declare class DeviceCheckerService {
     constructor(context: ProctoringContext);
     runCheckDevicesFlow(options: ProctoringSessionOptions, _videoOptions: Partial<ProctoringVideoOptions>, onModalConfirm: (resolve: (cameraId: string, microphoneId: string) => void) => void, onModalCancel: (reject: (error: Error) => void) => void, onUpdate: (feedback: any) => void): Promise<any>;
     private onUpdateCallback;
-    checkDevices(options: ProctoringSessionOptions | undefined, _videoOptions: ProctoringVideoOptions): Promise<checkDevicesReturn>;
+    checkDevices(options?: ProctoringSessionOptions, _videoOptions?: ProctoringVideoOptions): Promise<checkDevicesReturn>;
     private isUnderResolution;
     private realtimeAlerts;
     private videoDeviceInterface;

package/new-flow/recorders/CameraRecorder.d.ts

@@ -23,6 +23,7 @@ export declare class CameraRecorder implements IRecorder {
     backend: BackendService | undefined;
     backendToken: string | undefined;
     proctoringId: string | undefined;
+    private recorderOptions;
     upload: UploadService | undefined;
     video: HTMLVideoElement;
     canvas: HTMLCanvasElement;
@@ -45,6 +46,7 @@ export declare class CameraRecorder implements IRecorder {
     recordingStop: () => any;
     recordingPause: () => any;
     recordingResume: () => any;
+    getBufferSize: () => any;
     setProctoringId(proctoringId: string): void;
     initializeDetectors(): Promise<void>;
     configImageCapture(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easyproctor",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Modulo web de gravação do EasyProctor",
   "main": "./index.js",
   "module": "./esm/index.js",

package/plugins/insights.d.ts

@@ -12,7 +12,9 @@ declare const trackers: {
     registerChangeDevice: (proctoringId: string, inOrOut: string, devicesChanged: DevicesChanged) => Promise<string>;
     registerStopSharingScreen: (proctoringId: string, description: string) => Promise<string>;
     registerErrorRecorderRTC: (proctoringId: string, description: string) => Promise<string>;
+    registerDownloadFile: (proctoringId: string, description: string) => Promise<string>;
     registerOnBufferSizeError: (proctoringId: string, description: string) => Promise<string>;
     registerAnotherStream: (proctoringId: string, description: string) => Promise<string>;
+    registerSaveOnSession: (proctoringId: string, description: string) => Promise<string>;
 };
 export { trackers, init };

package/plugins/recorder.d.ts

@@ -3,4 +3,6 @@ export default function recorder(stream: MediaStream, buffer: Blob[], proctoring
     stopRecording: () => Promise<void>;
     pauseRecording: () => Promise<void>;
     resumeRecording: () => Promise<void>;
+    options: MediaRecorderOptions;
+    getBufferSize: () => number;
 };

package/proctoring/options/ProctoringVideoOptions.d.ts

@@ -5,3 +5,4 @@ export interface ProctoringVideoOptions {
     minHeight?: number;
 }
 export declare function validatePartialVideoOptions(options: Partial<ProctoringVideoOptions>): ProctoringVideoOptions;
+export declare const getDefaultProctoringVideoOptions: ProctoringVideoOptions;

package/proctoring/useProctoring.d.ts

@@ -10,7 +10,7 @@ export declare function useProctoring(proctoringOptions: ProctoringContext, envi
     onChangeDevices: (options?: import("./proctoring").ProctoringChangeDevicesOptions) => Promise<void>;
     onBufferSizeError: (cb: () => void) => void;
     onRealtimeAlerts: (options?: import("./proctoring").ProctoringRealtimeAlertsOptions) => Promise<void>;
-    checkDevices: (options: import("./options/ProctoringOptions").ProctoringSessionOptions | undefined, _videoOptions: import("./options/ProctoringVideoOptions").ProctoringVideoOptions) => Promise<import("../new-flow/checkers/DeviceCheckerService").checkDevicesReturn>;
+    checkDevices: (options?: import("./options/ProctoringOptions").ProctoringSessionOptions, _videoOptions?: import("./options/ProctoringVideoOptions").ProctoringVideoOptions) => Promise<import("../new-flow/checkers/DeviceCheckerService").checkDevicesReturn>;
     runCheckDevicesFlow: (options: import("./options/ProctoringOptions").ProctoringSessionOptions, _videoOptions: Partial<import("./options/ProctoringVideoOptions").ProctoringVideoOptions>, onModalConfirm: (resolve: (cameraId: string, microphoneId: string) => void) => void, onModalCancel: (reject: (error: Error) => void) => void, onUpdate: (feedback: any) => void) => Promise<any>;
     changeSelectedDevice: ({ cameraId, microphoneId }: any) => Promise<{
         cameraStream: MediaStream;