@newtonschool/react_proctoring_library 0.0.28 → 0.0.30

package/dist/components/ProctorApp.js

@@ -1,5 +1,7 @@
 "use strict";
 
+require("core-js/modules/es.object.assign.js");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -13,8 +15,6 @@ var _react = _interopRequireWildcard(require("react"));
 
 require("./index.scss");
 
-var _ = require(".");
-
 var _utils = require("../utils");
 
 var _hooks = require("../hooks");
@@ -29,12 +29,18 @@ var _webcamMicrophoneUtils = require("../utils/webcamMicrophoneUtils");
 
 var _defaults = require("../constants/defaults");
 
+var _activityTracker = _interopRequireDefault(require("./activity-tracker"));
+
+var _browserUtils = require("../utils/browserUtils");
+
 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; }
 
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -46,25 +52,43 @@ const isWebcamProcessingReliable = (0, _utils.isGPUAvailable)();
 const ProctorApp = _ref => {
   let {
     proctoringIdentifier,
+    customPermissionView = null,
+    shouldRenderChildren = false,
+    permissionPassedProps = {},
     children,
+    proctoredContext,
     config,
-    screensharePermission,
-    requestScreenshare = () => {},
     getProctorParamValues = () => {},
     getWebcamSnapshot = () => {},
     getScreengrab = () => {}
   } = _ref;
-  const webcamReference = (0, _react.useRef)(null);
-  const canvasReference = (0, _react.useRef)(null);
+  const [renderChildren, setRenderChildren] = (0, _react.useState)();
+  const context = (0, _react.useContext)(proctoredContext);
+  const {
+    actions,
+    permissions,
+    references,
+    permissionSetter,
+    customProps,
+    customSetter
+  } = context;
+  (0, _react.useEffect)(() => {
+    if (customProps.childrenRenderer === undefined) {
+      setRenderChildren(!shouldRenderChildren);
+    } else {
+      setRenderChildren(customProps.childrenRenderer);
+    }
+  }, [customProps]);
+  const CustomPermissionView = customPermissionView;
+  const browserDetails = {
+    isChrome: (0, _browserUtils.isChrome)()
+  };
   const proctorParams = (0, _react.useMemo)(() => _objectSpread(_objectSpread({}, _defaults.defaultConfig), config.proctorParams), [config.proctorParams]);
   const statistics = (0, _react.useRef)((0, _breachUtils.getInitialStats)(proctorParams));
   const {
     recurring = false,
     recurringFetchInterval = 0
   } = config;
-  const [audioPermission, setAudioPermission] = (0, _react.useState)();
-  const [videoPermission, setVideoPermission] = (0, _react.useState)();
-  const firstFullScreenDone = (0, _react.useRef)(false);
   const recurringFetchIntervalRef = (0, _react.useRef)(null);
   const sendScreengrab = (0, _react.useCallback)(async function () {
     let isBreach = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
@@ -80,9 +104,9 @@ const ProctorApp = _ref => {
     let breachedParam = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "";
 
     if (proctorParams.webcamSnapshots) {
-      const webcamSnapshot = (0, _utils.captureWebcamSnapshot)(webcamReference);
+      const webcamSnapshot = (0, _utils.captureWebcamSnapshot)(references.webcamReference);
 
-      if (webcamReference) {
+      if (references.webcamReference) {
         getWebcamSnapshot(proctoringIdentifier, webcamSnapshot, isBreach, breachedParam);
       }
     }
@@ -92,12 +116,8 @@ const ProctorApp = _ref => {
     let breachParam = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "";
     getProctorParamValues(proctoringIdentifier, statistics.current, isBreach, breachParam);
   }, [proctoringIdentifier, getProctorParamValues]);
-  const {
-    isFullscreen,
-    setFullscreen
-  } = (0, _hooks.useFullscreenData)(firstFullScreenDone, proctorParams.fullscreenExit);
-  const [userCount, lookedAwayCount] = (0, _useWebcamData.default)(webcamReference, canvasReference, proctorParams);
-  const isTabSwitched = !(0, _hooks.usePageVisibility)(proctorParams.tabSwitch) && firstFullScreenDone.current;
+  const [userCount, lookedAwayCount] = (0, _useWebcamData.default)(references.webcamReference, references.canvasReference, proctorParams);
+  const isTabSwitched = !(0, _hooks.usePageVisibility)(proctorParams.tabSwitch);
   (0, _react.useEffect)(() => {
     if (recurring) {
       recurringFetchIntervalRef.current = setInterval(() => {
@@ -115,9 +135,9 @@ const ProctorApp = _ref => {
     const currentStats = {
       userCount,
       isTabSwitched,
-      isFullscreen,
+      isFullScreen: permissions.fullscreen,
       lookedAwayCount,
-      isWebcamDataReliable: isWebcamProcessingReliable
+      isWebcamDataNotReliable: !isWebcamProcessingReliable
     };
     const breachData = (0, _breachUtils.getDataOnBreach)(statistics, currentStats, proctorParams);
     (0, _utils.updateStatistics)(statistics, currentStats, proctorParams);
@@ -127,28 +147,32 @@ const ProctorApp = _ref => {
       sendWebcamSnapshot(true, breachData.breachedParam);
       sendScreengrab(true, breachData.breachedParam);
     }
-  }, [userCount, isTabSwitched, isFullscreen, lookedAwayCount, sendProctoredParamValues, sendWebcamSnapshot, sendScreengrab, proctorParams]);
+  }, [userCount, isTabSwitched, permissions.fullscreen, lookedAwayCount, sendProctoredParamValues, sendWebcamSnapshot, sendScreengrab, proctorParams]);
   return /*#__PURE__*/_react.default.createElement("div", {
-    className: "".concat(proctorParams.copyPasteProctoring ? "disable-copy-paste fullwidth fullheight" : "fullwidth fullheight")
-  }, (0, _breachUtils.showProctoredComponent)(proctorParams, {
-    isFullscreen,
-    audioPermission,
-    videoPermission,
-    screensharePermission
-  }) && children, /*#__PURE__*/_react.default.createElement(_permissions.Permission, {
+    className: "".concat(proctorParams.copyPasteProctoring ? "disable-copy-paste fullwidth" : "fullwidth")
+  }, (0, _breachUtils.showProctoredComponent)(proctorParams, actions.hasAllPermission) && renderChildren && children, !((0, _breachUtils.showProctoredComponent)(proctorParams, actions.hasAllPermission) && renderChildren) && customPermissionView && /*#__PURE__*/_react.default.createElement(CustomPermissionView, _extends({
+    permissions: permissions,
+    hasAllPermission: actions.hasAllPermission,
+    askPermission: actions.askPermission,
+    references: references,
+    actions: actions,
+    browserDetails: browserDetails,
+    renderChildren: () => {
+      setRenderChildren(true);
+      customSetter.childrenRenderer(true);
+    }
+  }, permissionPassedProps)), !((0, _breachUtils.showProctoredComponent)(proctorParams, actions.hasAllPermission) && renderChildren) && !customPermissionView && /*#__PURE__*/_react.default.createElement(_permissions.Permission, {
     proctorParams: proctorParams,
-    isFullscreen: isFullscreen,
-    audioPermisison: audioPermission,
-    videoPermission: videoPermission,
-    setFullscreen: setFullscreen,
-    screensharePermission: screensharePermission,
-    requestScreenshare: requestScreenshare
-  }), /*#__PURE__*/_react.default.createElement(_.ActivityTracker, {
+    permissions: permissions,
+    askPermission: actions.askPermission,
+    hasAllPermission: actions.hasAllPermission
+  }), /*#__PURE__*/_react.default.createElement(_activityTracker.default, {
     proctorParams: proctorParams,
-    setAudioPermission: setAudioPermission,
-    setVideoPermission: setVideoPermission,
-    webcamReference: webcamReference,
-    canvasReference: canvasReference
+    setAudioPermission: permissionSetter.audio,
+    setVideoPermission: permissionSetter.video,
+    webcamReference: references.webcamReference,
+    canvasReference: references.canvasReference,
+    screenshareReference: references.screenshareReference
   }));
 };
 

package/dist/components/ProctoredContextApp.js

@@ -0,0 +1,109 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+require("core-js/modules/web.dom-collections.iterator.js");
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _hooks = require("../hooks");
+
+var _webcamMicrophoneUtils = require("../utils/webcamMicrophoneUtils");
+
+var _defaults = require("../constants/defaults");
+
+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; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+const ProctoredContextApp = _ref => {
+  let {
+    contextProvider,
+    config = {
+      proctorParams: _defaults.defaultConfig
+    },
+    children
+  } = _ref;
+  const proctorParams = (0, _react.useMemo)(() => _objectSpread(_objectSpread({}, _defaults.defaultConfig), config.proctorParams), [config.proctorParams]);
+  const {
+    isFullscreen,
+    setFullscreen
+  } = (0, _hooks.useFullscreenData)(proctorParams.fullscreenExit);
+  const [audioPermisison, setAudioPermission] = (0, _react.useState)();
+  const [videoPermission, setVideoPermission] = (0, _react.useState)();
+  const [screensharePermission, setScreensharePermission] = (0, _react.useState)();
+  const [customRenderer, setCustomRenderer] = (0, _react.useState)();
+  const webcamReference = (0, _react.useRef)(null);
+  const canvasReference = (0, _react.useRef)(null);
+  const screenshareReference = (0, _react.useRef)(null);
+  const Context = contextProvider;
+  const askPermissionAction = {
+    'screenshare': () => {
+      (0, _webcamMicrophoneUtils.setupScreensharePermission)(setScreensharePermission, screenshareReference);
+    },
+    'fullscreen': () => {
+      setFullscreen();
+    }
+  };
+  const getPermissionObj = {
+    'video': videoPermission,
+    'audio': audioPermisison,
+    'fullscreen': isFullscreen,
+    'screenshare': screensharePermission
+  };
+  const askPermission = (0, _react.useCallback)(requiredPermissions => {
+    console.log(requiredPermissions);
+    requiredPermissions.forEach(element => {
+      if (!getPermissionObj[element] && askPermissionAction[element]) {
+        askPermissionAction[element]();
+      }
+    });
+  }, [getPermissionObj, askPermissionAction]);
+  const hasAllPermission = (0, _react.useCallback)(requiredPermissions => {
+    let hasPermission = true;
+    requiredPermissions.forEach(element => {
+      if (!getPermissionObj[element]) {
+        hasPermission = hasPermission && false;
+      }
+    });
+    return hasPermission;
+  }, [getPermissionObj]);
+  return /*#__PURE__*/_react.default.createElement(Context.Provider, {
+    value: {
+      permissions: getPermissionObj,
+      permissionSetter: {
+        'audio': setAudioPermission,
+        'video': setVideoPermission,
+        'screenshare': setScreensharePermission
+      },
+      customProps: {
+        'childrenRenderer': customRenderer
+      },
+      customSetter: {
+        'childrenRenderer': setCustomRenderer
+      },
+      proctorParams,
+      actions: {
+        'askPermission': askPermission,
+        'hasAllPermission': hasAllPermission
+      },
+      references: {
+        'webcamReference': webcamReference,
+        'canvasReference': canvasReference,
+        'screenshareReference': screenshareReference
+      }
+    }
+  }, children);
+};
+
+var _default = ProctoredContextApp;
+exports.default = _default;

package/dist/components/index.scss

@@ -6,7 +6,3 @@
 .fullwidth {
     width: 100%;
 }
-.fullheight {
-    height: 100%;
-    overflow-y: scroll;
-}

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

@@ -39,7 +39,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 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; }
 
-function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 

package/dist/proctoringTracker/tracker.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+class ProctoringTracker {
+  constructor() {}
+
+  askProctoredPermission() {}
+
+  hasProctoredPermission() {}
+
+}
+
+exports.default = ProctoringTracker;

package/dist/proctoringTracker/trackerWrapper.js

@@ -0,0 +1 @@
+"use strict";

package/dist/utils/webcamMicrophoneUtils.js

@@ -13,6 +13,8 @@ require("core-js/modules/es.array-buffer.slice.js");
 
 require("core-js/modules/es.typed-array.uint8-array.js");
 
+require("core-js/modules/es.typed-array.fill.js");
+
 require("core-js/modules/es.typed-array.set.js");
 
 require("core-js/modules/es.typed-array.sort.js");

package/package.json

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

package/dist/utils/localStorageUtils.js

@@ -1,33 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.retrieveStatsFromLocalStorage = exports.removeStatsFromLocalStorage = exports.getStatistics = exports.addOrUpdateStatsToLocalStorage = void 0;
-
-require("core-js/modules/es.json.stringify.js");
-
-const addOrUpdateStatsToLocalStorage = (proctoringIdentifier, data) => {
-  const stringifiedData = JSON.stringify(data);
-  localStorage.setItem(proctoringIdentifier, stringifiedData);
-};
-
-exports.addOrUpdateStatsToLocalStorage = addOrUpdateStatsToLocalStorage;
-
-const retrieveStatsFromLocalStorage = proctoringIdentifier => {
-  return localStorage.getItem(proctoringIdentifier);
-};
-
-exports.retrieveStatsFromLocalStorage = retrieveStatsFromLocalStorage;
-
-const removeStatsFromLocalStorage = proctoringIdentifier => {
-  localStorage.removeItem(proctoringIdentifier);
-};
-
-exports.removeStatsFromLocalStorage = removeStatsFromLocalStorage;
-
-const getStatistics = proctoringIdentifier => {
-  return JSON.parse(retrieveStatsFromLocalStorage(proctoringIdentifier));
-};
-
-exports.getStatistics = getStatistics;