@newtonschool/react_proctoring_library 0.0.54 → 0.0.56

package/dist/components/proctor-app/index.js

@@ -10,6 +10,7 @@ require("core-js/modules/es.promise.js");
 require("core-js/modules/web.dom-collections.iterator.js");
 require("core-js/modules/es.symbol.description.js");
 var _react = _interopRequireWildcard(require("react"));
+var _useWakeUpLock = require("../../hooks/useWakeUpLock");
 require("./index.scss");
 var _utils = require("../../utils");
 var _hooks = require("../../hooks");
@@ -22,6 +23,7 @@ var _webcamActivityTracker = _interopRequireDefault(require("../webcam-activity-
 var _browserUtils = require("../../utils/browserUtils");
 var _screenshareActivityTracker = require("../screenshare-activity-tracker");
 var _dom = require("../../constants/dom");
+var _useIsPageFocussed = _interopRequireDefault(require("../../hooks/useIsPageFocussed"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -53,6 +55,14 @@ const ProctorApp = _ref => {
     permissionSetter,
     screenshareStream
   } = context;
+  const {
+    acquireWakeUpLock,
+    releaseWakeUpLock
+  } = (0, _useWakeUpLock.useWakeUpLock)();
+  (0, _react.useEffect)(() => {
+    acquireWakeUpLock();
+    return releaseWakeUpLock;
+  }, []);
   const CustomPermissionView = customPermissionView;
   const proctorParams = (0, _react.useMemo)(() => _objectSpread(_objectSpread({}, _defaults.defaultConfig), config.proctorParams), [config.proctorParams]);
   const statistics = (0, _react.useRef)((0, _breachUtils.getInitialStats)(proctorParams));
@@ -84,6 +94,7 @@ const ProctorApp = _ref => {
   }, [proctoringIdentifier, getProctorParamValues]);
   const [userCount, lookedAwayCount] = (0, _useWebcamData.default)(references.webcamReference, references.canvasReference, proctorParams);
   const isTabSwitched = !(0, _hooks.usePageVisibility)(proctorParams.tabSwitch);
+  const isPageFocussed = (0, _useIsPageFocussed.default)(proctorParams.pageFocus);
   (0, _react.useEffect)(() => {
     if (recurring) {
       recurringFetchIntervalRef.current = setInterval(() => {
@@ -102,7 +113,8 @@ const ProctorApp = _ref => {
       isTabSwitched,
       isFullScreen: permissions.fullscreen,
       lookedAwayCount,
-      isWebcamDataNotReliable: !isWebcamProcessingReliable
+      isWebcamDataNotReliable: !isWebcamProcessingReliable,
+      isPageFocussed
     };
     const breachData = (0, _breachUtils.getDataOnBreach)(statistics, currentStats, proctorParams);
     (0, _utils.updateStatistics)(statistics, currentStats, proctorParams);
@@ -111,7 +123,7 @@ const ProctorApp = _ref => {
       sendWebcamSnapshot(true, breachData.breachedParam);
       sendScreengrab(true, breachData.breachedParam);
     }
-  }, [userCount, isTabSwitched, permissions.fullscreen, lookedAwayCount, sendProctoredParamValues, sendWebcamSnapshot, sendScreengrab, proctorParams]);
+  }, [userCount, isTabSwitched, isPageFocussed, permissions.fullscreen, lookedAwayCount, sendProctoredParamValues, sendWebcamSnapshot, sendScreengrab, proctorParams]);
   const shouldShowProctoredComponent = (0, _breachUtils.showProctoredComponent)(proctorParams, permissions);
   return /*#__PURE__*/_react.default.createElement("div", {
     className: "".concat(proctorParams.copyPasteProctoring ? 'disable-copy-paste fullwidth fullheight' : 'fullwidth fullheight')

package/dist/constants/defaults.js

@@ -11,11 +11,13 @@ const defaultConfig = {
   lookedAway: true,
   webcamSnapshots: true,
   screenshareSnapshots: true,
-  copyPasteProctoring: true
+  copyPasteProctoring: true,
+  pageFocus: true
 };
 exports.defaultConfig = defaultConfig;
 const initialValues = {
   isTabSwitched: false,
+  pageFocus: true,
   userCount: 0,
   isWebcamDataNotReliable: true,
   isWatching: true,
@@ -26,11 +28,12 @@ const initialValues = {
 };
 exports.initialValues = initialValues;
 const STATS_PARAMS = {
-  isTabSwitched: "IS_TAB_SWITCHED",
-  isFullscreen: "IS_FULLSCREEN",
-  lookedAwayCount: "LOOKED_AWAY_COUNT",
-  userCountMax: "USER_COUNT_MAX",
-  isWebcamNotReliable: "IS_WEBCAM_DATA_NOT_RELIABLE"
+  isTabSwitched: 'IS_TAB_SWITCHED',
+  isPageFocussed: 'PAGE_FOCUS',
+  isFullscreen: 'IS_FULLSCREEN',
+  lookedAwayCount: 'LOOKED_AWAY_COUNT',
+  userCountMax: 'USER_COUNT_MAX',
+  isWebcamNotReliable: 'IS_WEBCAM_DATA_NOT_RELIABLE'
 };
 exports.STATS_PARAMS = STATS_PARAMS;
 const INITIAL_STATISTICS = {
@@ -42,13 +45,13 @@ const INITIAL_STATISTICS = {
 };
 exports.INITIAL_STATISTICS = INITIAL_STATISTICS;
 const proctorParamsToPermission = {
-  fullscreenExit: "fullscreen",
-  lookedAway: "video",
-  webcamSnapshots: "video",
-  screenshareSnapshots: "screenshare"
+  fullscreenExit: 'fullscreen',
+  lookedAway: 'video',
+  webcamSnapshots: 'video',
+  screenshareSnapshots: 'screenshare'
 };
 exports.proctorParamsToPermission = proctorParamsToPermission;
 const evaluateVideoIntervalInSeconds = 5;
 exports.evaluateVideoIntervalInSeconds = evaluateVideoIntervalInSeconds;
-const gpuTypes = ["intel", "apple", "amd", "radeon", "nvidia", "geforce"];
+const gpuTypes = ['intel', 'apple', 'amd', 'radeon', 'nvidia', 'geforce'];
 exports.gpuTypes = gpuTypes;

package/dist/hooks/useIsPageFocussed.js

@@ -10,13 +10,7 @@ var _utils = require("../utils");
 const focusEvent = (0, _utils.getFocusEventName)();
 const blurEvent = (0, _utils.getBlurEventName)();
 function useIsPageFocussed(isProctorParam) {
-  const [isFocussed, setIsFocussed] = (0, _react.useState)(true);
-  const updateVisibilityOnFocus = () => {
-    setIsFocussed(true);
-  };
-  const updateVisibilityOnBlur = () => {
-    setIsFocussed(false);
-  };
+  const [isPageFocussed, setIsPageFocussed] = (0, _react.useState)(true);
   (0, _react.useEffect)(() => {
     window.addEventListener(focusEvent, updateVisibilityOnFocus, false);
     window.addEventListener(blurEvent, updateVisibilityOnBlur, false);
@@ -25,5 +19,13 @@ function useIsPageFocussed(isProctorParam) {
       window.removeEventListener(blurEvent, updateVisibilityOnBlur);
     };
   }, []);
-  return isFocussed && isProctorParam;
+  const updateVisibilityOnFocus = () => {
+    setIsPageFocussed(true);
+  };
+  const updateVisibilityOnBlur = () => {
+    if ((0, _utils.getIsDocumentVisible)()) {
+      setIsPageFocussed(false);
+    }
+  };
+  return isPageFocussed && isProctorParam;
 }

package/dist/hooks/useWakeUpLock.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useWakeUpLock = void 0;
+require("core-js/modules/es.promise.js");
+var _react = require("react");
+const useWakeUpLock = () => {
+  const wakeLock = (0, _react.useRef)();
+  const canWakeLock = () => 'wakeLock' in navigator;
+  const acquireWakeUpLock = async () => {
+    try {
+      if (!canWakeLock()) return;
+      wakeLock.current = await navigator.wakeLock.request();
+    } catch (e) {
+      // pass
+    }
+  };
+  function releaseWakeUpLock() {
+    try {
+      if (wakeLock.current) {
+        wakeLock.current.release();
+        wakeLock.current = null;
+      }
+    } catch (_unused) {
+      // pass
+    }
+  }
+  return {
+    acquireWakeUpLock,
+    releaseWakeUpLock
+  };
+};
+exports.useWakeUpLock = useWakeUpLock;

package/dist/utils/breachUtils.js

@@ -26,6 +26,9 @@ const getInitialStats = proctorParams => {
   if (proctorParams.lookedAway) {
     initialStats[_defaults.STATS_PARAMS.lookedAwayCount] = _defaults.initialValues.lookedAwayCount;
   }
+  if (proctorParams.pageFocus) {
+    initialStats[_defaults.STATS_PARAMS.isPageFocussed] = _defaults.initialValues.pageFocus;
+  }
   return initialStats;
 };
 exports.getInitialStats = getInitialStats;
@@ -53,7 +56,8 @@ const getDataOnBreach = (statistics, currentData, proctorParams) => {
     isTabSwitched,
     isFullScreen,
     lookedAwayCount,
-    isWebcamDataNotReliable
+    isWebcamDataNotReliable,
+    isPageFocussed
   } = currentData;
   const timestamp = Date.now();
   const data = statistics.current;
@@ -87,6 +91,16 @@ const getDataOnBreach = (statistics, currentData, proctorParams) => {
       })
     };
   }
+  const isPageFocusParam = _defaults.STATS_PARAMS.isPageFocussed;
+  if (proctorParams.pageFocus && !isPageFocussed && data[isPageFocusParam]) {
+    return {
+      breachedParam: isPageFocusParam,
+      timestamp,
+      data: _objectSpread(_objectSpread({}, data), {}, {
+        [isPageFocusParam]: isPageFocussed
+      })
+    };
+  }
   const fullscreenExitParam = _defaults.STATS_PARAMS.isFullscreen;
   if (proctorParams.fullscreenExit && !isFullScreen && data[fullscreenExitParam]) {
     return {

package/dist/utils/webcamMicrophoneUtils.js

@@ -23,7 +23,8 @@ const updateStatistics = (statistics, currentStats, proctorParams) => {
     isFullScreen,
     lookedAwayCount,
     userCount,
-    isWebcamDataReliable
+    isWebcamDataReliable,
+    isPageFocussed
   } = currentStats;
   if (proctorParams.tabSwitch) {
     statistics.current[_defaults.STATS_PARAMS.isTabSwitched] = isTabSwitched;
@@ -37,6 +38,9 @@ const updateStatistics = (statistics, currentStats, proctorParams) => {
   if (proctorParams.people) {
     statistics.current[_defaults.STATS_PARAMS.userCountMax] = Math.max(userCount, statistics.current[_defaults.STATS_PARAMS.userCountMax]);
   }
+  if (proctorParams.pageFocus) {
+    statistics.current[_defaults.STATS_PARAMS.isPageFocussed] = isPageFocussed;
+  }
   statistics.current.IS_WEBCAM_DATA_RELIABLE = isWebcamDataReliable;
 };
 exports.updateStatistics = updateStatistics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newtonschool/react_proctoring_library",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "description": "Used to proctor online tests",
   "author": "ayushkagrawal,shreyachandra,weastel",
   "main": "dist/index.js",