@newtonschool/react_proctoring_library 0.0.125 → 0.0.126-beta.1

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

@@ -26,6 +26,7 @@ var _permission = require("../../utils/permission");
 var _openHeimdall = require("../openHeimdall");
 var _ElectronContext = require("../../contexts/ElectronContext");
 var _disableExtendedDisplay = require("../disable-extended-display");
+var _secondaryDevice = require("../secondaryDevice");
 var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
@@ -46,7 +47,9 @@ const ProctorApp = _ref => {
     getWebcamSnapshot = () => {},
     getScreengrab = () => {},
     logger = () => {},
-    onProctoredViewChange = () => {}
+    onProctoredViewChange = () => {},
+    isSecondaryDevice,
+    firebaseClient
   } = _ref;
   const context = (0, _react.useContext)(proctoredContext);
   const isElectronApp = (0, _react.useContext)(_ElectronContext.ElectronContext);
@@ -124,6 +127,13 @@ const ProctorApp = _ref => {
       permissions: permissions,
       proctorParams: proctorParams,
       askPermission: askPermission
+    }), proctorParams.secondaryDevice && /*#__PURE__*/(0, _jsxRuntime.jsx)(_secondaryDevice.SecondaryDevice, {
+      proctorParams: proctorParams,
+      permissions: permissions,
+      proctoredContext: proctoredContext,
+      isSecondaryDevice: isSecondaryDevice,
+      firebaseClient: firebaseClient,
+      allPermissionGranted: allPermissionGrantedOnce.current
     }), proctorParams.webcamSnapshots && /*#__PURE__*/(0, _jsxRuntime.jsx)(_webcamActivityTracker.default, {
       logger: logger,
       config: config,
@@ -131,7 +141,9 @@ const ProctorApp = _ref => {
       proctoredContext: proctoredContext,
       getWebcamSnapshot: getWebcamSnapshot,
       proctoringIdentifier: proctoringIdentifier,
-      setAskPermissionAction: setAskPermissionAction
+      setAskPermissionAction: setAskPermissionAction,
+      firebaseClient: firebaseClient,
+      isSecondaryDevice: isSecondaryDevice
     }), proctorParams.screenshareSnapshots && /*#__PURE__*/(0, _jsxRuntime.jsx)(_screenshareActivityTracker.default, {
       config: config,
       getScreengrab: getScreengrab,

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

@@ -52,6 +52,7 @@ const ProctoredContextApp = _ref => {
     openHeimdall: null
   });
   const [screenshareStream, setScreenshareStream] = (0, _react.useState)(null);
+  const [secondaryDevicePermission, setSecondaryDevicePermission] = (0, _react.useState)(null);
   const downloadHeimdallUrl = (0, _react.useRef)(null);
   const allPermissionGrantedOnce = (0, _react.useRef)(false);
   const webcamReference = (0, _react.useRef)(null);
@@ -67,8 +68,9 @@ const ProctoredContextApp = _ref => {
     fullscreen: isFullscreen,
     screenshare: screensharePermission,
     openHeimdall: openHeimdallAppPermission,
-    singleScreen: !extendedDisplayConnected
-  }), [videoPermission, audioPermission, isFullscreen, screensharePermission, openHeimdallAppPermission, extendedDisplayConnected]);
+    singleScreen: !extendedDisplayConnected,
+    secondaryDevice: secondaryDevicePermission
+  }), [videoPermission, audioPermission, isFullscreen, screensharePermission, openHeimdallAppPermission, extendedDisplayConnected, secondaryDevicePermission]);
   const proctorParams = (0, _react.useMemo)(() => _objectSpread(_objectSpread({}, _defaults.defaultConfig), config.proctorParams), [config.proctorParams]);
   const Context = contextProvider;
   const forceUpdate = () => {
@@ -87,7 +89,8 @@ const ProctoredContextApp = _ref => {
         audio: setAudioPermission,
         video: setVideoPermission,
         screenshare: setScreensharePermission,
-        openHeimdall: setOpenHeimdallAppPermission
+        openHeimdall: setOpenHeimdallAppPermission,
+        secondaryDevice: setSecondaryDevicePermission
       },
       streamSetter: {
         screenshare: setScreenshareStream

package/dist/components/secondaryDevice/index.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SecondaryDevice = void 0;
+require("core-js/modules/web.dom-collections.iterator.js");
+var _react = require("react");
+var _proctoringStatusUtils = require("../../utils/proctoringStatusUtils");
+var _permission = require("../../utils/permission");
+var _breachUtils = require("../../utils/breachUtils");
+const SecondaryDevice = _ref => {
+  let {
+    proctoredContext,
+    isSecondaryDevice,
+    firebaseClient,
+    proctorParams,
+    permissions
+  } = _ref;
+  const {
+    permissionSetter
+  } = (0, _react.useContext)(proctoredContext);
+  const setSecondaryDevicePermission = permissionSetter.secondaryDevice;
+  const [primaryDeviceOnline, setPrimaryDeviceOnline] = (0, _react.useState)(false);
+  const [secondaryDeviceOnline, setSecondaryDeviceOnline] = (0, _react.useState)(false);
+  const [secondaryDeviceAllPermissionGranted, setSecondaryDeviceAllPermissionGranted] = (0, _react.useState)(false);
+  const allPermissionGranted = (0, _permission.hasAllPermissions)((0, _breachUtils.getRequiredPermissionsFromProctorParams)(proctorParams), permissions);
+  (0, _react.useEffect)(() => {
+    const cleanup = (0, _proctoringStatusUtils.setupDeviceStatusListeners)({
+      firebaseClient,
+      isSecondaryDevice,
+      onPrimaryDeviceStatusChange: connectionStatus => {
+        setPrimaryDeviceOnline(connectionStatus);
+      },
+      onSecondaryDeviceStatusChange: (connectionStatus, allPermissionGranted) => {
+        setSecondaryDeviceOnline(connectionStatus);
+        setSecondaryDeviceAllPermissionGranted(allPermissionGranted);
+      },
+      allPermissionGranted
+    });
+    return cleanup;
+  }, [firebaseClient, isSecondaryDevice, allPermissionGranted]);
+  (0, _react.useEffect)(() => {
+    if (isSecondaryDevice) {
+      setSecondaryDevicePermission(primaryDeviceOnline && secondaryDeviceOnline);
+    } else {
+      setSecondaryDevicePermission(primaryDeviceOnline && secondaryDeviceOnline && secondaryDeviceAllPermissionGranted);
+    }
+  }, [isSecondaryDevice, primaryDeviceOnline, secondaryDeviceOnline, secondaryDeviceAllPermissionGranted, setSecondaryDevicePermission]);
+  return null;
+};
+exports.SecondaryDevice = SecondaryDevice;

package/dist/components/webcam-activity-tracker/index.js

@@ -21,7 +21,9 @@ const WebCam = _ref => {
     logger,
     config,
     getWebcamSnapshot,
-    proctoringIdentifier
+    proctoringIdentifier,
+    firebaseClient,
+    isSecondaryDevice
   } = _ref;
   const isElectronApp = (0, _react.useContext)(_ElectronContext.ElectronContext);
   if (isElectronApp) {
@@ -39,7 +41,9 @@ const WebCam = _ref => {
     logger: logger,
     config: config,
     getWebcamSnapshot: getWebcamSnapshot,
-    proctoringIdentifier: proctoringIdentifier
+    proctoringIdentifier: proctoringIdentifier,
+    firebaseClient: firebaseClient,
+    isSecondaryDevice: isSecondaryDevice
   });
 };
 var _default = exports.default = WebCam;

package/dist/components/webcam-activity-tracker/web.js

@@ -19,6 +19,7 @@ var _browserUtils = require("../../utils/browserUtils");
 var _webcamMicrophoneUtils = require("../../utils/webcamMicrophoneUtils");
 var _dom = require("../../constants/dom");
 var _useBreachData = require("../../hooks/useBreachData");
+var _proctoringStatusUtils = require("../../utils/proctoringStatusUtils");
 var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
@@ -36,7 +37,9 @@ const WebWebCam = _ref => {
     proctoredContext,
     getWebcamSnapshot,
     proctoringIdentifier,
-    config
+    config,
+    firebaseClient,
+    isSecondaryDevice
   } = _ref;
   const {
     permissionSetter,
@@ -106,6 +109,13 @@ const WebWebCam = _ref => {
       ref: webcamReference,
       onUserMedia: () => {
         setVideoPermission(true);
+        if (firebaseClient) {
+          if (isSecondaryDevice) {
+            (0, _proctoringStatusUtils.setSecondaryDeviceConnected)(firebaseClient);
+          } else {
+            (0, _proctoringStatusUtils.setPrimaryDeviceConnected)(firebaseClient);
+          }
+        }
       },
       onUserMediaError: err => {
         logger("Retry Count = ".concat(retryCount, " | Webcam error, onUserMediaError | ").concat(err.toString()));

package/dist/constants/defaults.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.proctorParamsToPermission = exports.initialValues = exports.gpuTypes = exports.evaluateVideoIntervalInSeconds = exports.defaultConfig = exports.URL_VIDEO_PERMISSION_HIGHLIGHT = exports.STATS_PARAMS = exports.INITIAL_STATISTICS = void 0;
+exports.proctorParamsToPermission = exports.initialValues = exports.gpuTypes = exports.evaluateVideoIntervalInSeconds = exports.defaultConfig = exports.URL_VIDEO_PERMISSION_HIGHLIGHT = exports.STATS_PARAMS = exports.PROCTORING_STATUS_PATH = exports.INITIAL_STATISTICS = void 0;
 const defaultConfig = exports.defaultConfig = {
   tabSwitch: true,
   fullscreenExit: true,
@@ -47,8 +47,10 @@ const proctorParamsToPermission = exports.proctorParamsToPermission = {
   audio: 'audio',
   openHeimdall: 'openHeimdall',
   downloadHeimdall: 'downloadHeimdall',
-  disableExtendedDisplay: 'singleScreen'
+  disableExtendedDisplay: 'singleScreen',
+  secondaryDevice: 'secondaryDevice'
 };
 const evaluateVideoIntervalInSeconds = exports.evaluateVideoIntervalInSeconds = 5;
 const gpuTypes = exports.gpuTypes = ['intel', 'apple', 'amd', 'radeon', 'nvidia', 'geforce'];
-const URL_VIDEO_PERMISSION_HIGHLIGHT = exports.URL_VIDEO_PERMISSION_HIGHLIGHT = 'https://d3dyfaf3iutrxo.cloudfront.net/general/upload/2bbf06308d7549de81502005bfa1365f.png';
+const URL_VIDEO_PERMISSION_HIGHLIGHT = exports.URL_VIDEO_PERMISSION_HIGHLIGHT = 'https://d3dyfaf3iutrxo.cloudfront.net/general/upload/2bbf06308d7549de81502005bfa1365f.png';
+const PROCTORING_STATUS_PATH = exports.PROCTORING_STATUS_PATH = 'proctoringStatus';

package/dist/utils/index.js

@@ -75,6 +75,18 @@ Object.defineProperty(exports, "isWebcamVideoValid", {
     return _webcamMicrophoneUtils.isWebcamVideoValid;
   }
 });
+Object.defineProperty(exports, "setPrimaryDeviceConnected", {
+  enumerable: true,
+  get: function get() {
+    return _proctoringStatusUtils.setPrimaryDeviceConnected;
+  }
+});
+Object.defineProperty(exports, "setupDeviceStatusListeners", {
+  enumerable: true,
+  get: function get() {
+    return _proctoringStatusUtils.setupDeviceStatusListeners;
+  }
+});
 Object.defineProperty(exports, "updateStatistics", {
   enumerable: true,
   get: function get() {
@@ -84,4 +96,5 @@ Object.defineProperty(exports, "updateStatistics", {
 var _webcamMicrophoneUtils = require("./webcamMicrophoneUtils");
 var _browserUtils = require("./browserUtils");
 var _arrayUtils = require("./arrayUtils");
-var _gpuUtils = require("./gpuUtils");
+var _gpuUtils = require("./gpuUtils");
+var _proctoringStatusUtils = require("./proctoringStatusUtils");

package/dist/utils/permission.js

@@ -8,13 +8,17 @@ require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.for-each.js");
 const hasAllPermissions = (requiredPermissions, permissions) => {
   let hasPermission = true;
+  const status = {};
   requiredPermissions.forEach(element => {
+    const granted = permissions ? Boolean(permissions[element]) : false;
+    status[element] = granted;
     if (!permissions) {
       hasPermission = false;
     } else if (!permissions[element]) {
       hasPermission = hasPermission && false;
     }
   });
+  console.log('::[hasAllPermissions]', status, 'allGranted:', hasPermission);
   return hasPermission;
 };
 exports.hasAllPermissions = hasAllPermissions;

package/dist/utils/proctoringStatusUtils.js

@@ -0,0 +1,114 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setupDeviceStatusListeners = exports.setSecondaryDeviceConnected = exports.setPrimaryDeviceConnected = void 0;
+var _defaults = require("../constants/defaults");
+/**
+ * Marks the primary device as connected in Firebase. Call when desktop webcam
+ * connects successfully. No-op if firebaseClient is missing required fields.
+ *
+ * @param {Object} firebaseClient
+ * @returns {Promise<void>|undefined} Resolves when set completes, or undefined if skipped
+ */
+const setPrimaryDeviceConnected = firebaseClient => {
+  if (!(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.userUuid) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.myFirebaseDB) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.setValue) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.getRef)) {
+    return undefined;
+  }
+  const {
+    updateValue: update,
+    getRef: ref
+  } = firebaseClient;
+  const primaryDeviceRef = ref(firebaseClient.myFirebaseDB, "".concat(_defaults.PROCTORING_STATUS_PATH, "/").concat(firebaseClient.userUuid, "/primaryDevice"));
+  const payload = {
+    connected: true
+  };
+  return update(primaryDeviceRef, payload).catch(error => {
+    console.error('::[proctoringStatusUtils] Failed to set primary device status online:', error);
+  });
+};
+
+/**
+ * Marks the secondary device as connected in Firebase. Call when secondary
+ * device webcam connects successfully. No-op if firebaseClient is missing required fields.
+ *
+ * @param {Object} firebaseClient - { userUuid, myFirebaseDB, setValue, getRef }
+ * @returns {Promise<void>|undefined} Resolves when set completes, or undefined if skipped
+ */
+exports.setPrimaryDeviceConnected = setPrimaryDeviceConnected;
+const setSecondaryDeviceConnected = firebaseClient => {
+  if (!(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.userUuid) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.myFirebaseDB) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.setValue) || !(firebaseClient !== null && firebaseClient !== void 0 && firebaseClient.getRef)) {
+    return undefined;
+  }
+  const {
+    updateValue: update,
+    getRef: ref
+  } = firebaseClient;
+  const secondaryDeviceRef = ref(firebaseClient.myFirebaseDB, "".concat(_defaults.PROCTORING_STATUS_PATH, "/").concat(firebaseClient.userUuid, "/secondaryDevice"));
+  const payload = {
+    connected: true
+  };
+  return update(secondaryDeviceRef, payload).catch(error => {
+    console.error('::[proctoringStatusUtils] Failed to set secondary device status online:', error);
+  });
+};
+
+/**
+ * Sets up Firebase device status: marks current device (primary/secondary) as connected,
+ * registers onDisconnect, and subscribes to primary and secondary status.
+ * Returns a cleanup function to unsubscribe listeners.
+ *
+ * @param {Object} params
+ * @param {Object} params.firebaseClient
+ * @param {boolean} params.isSecondaryDevice
+ * @param {(connected: boolean) => void} params.onPrimaryDeviceStatusChange
+ * @param {(connected: boolean) => void} params.onSecondaryDeviceStatusChange
+ * @param {boolean} params.allPermissionGranted
+ * @returns {() => void} Cleanup function to unsubscribe, or no-op if setup skipped
+ */
+exports.setSecondaryDeviceConnected = setSecondaryDeviceConnected;
+const setupDeviceStatusListeners = _ref => {
+  let {
+    firebaseClient,
+    isSecondaryDevice,
+    onPrimaryDeviceStatusChange,
+    onSecondaryDeviceStatusChange,
+    allPermissionGranted
+  } = _ref;
+  const {
+    userUuid,
+    firestoreAuthStatus,
+    myFirebaseDB,
+    setValue: set,
+    getRef: ref,
+    updateValue: update,
+    onDisconnect,
+    getValue: onValue
+  } = firebaseClient || {};
+  if (!userUuid || !firestoreAuthStatus || !ref || !set || !onDisconnect || !onValue) {
+    return () => {};
+  }
+  const primaryDeviceStatusRef = ref(myFirebaseDB, "".concat(_defaults.PROCTORING_STATUS_PATH, "/").concat(userUuid, "/primaryDevice"));
+  const secondaryDeviceStatusRef = ref(myFirebaseDB, "".concat(_defaults.PROCTORING_STATUS_PATH, "/").concat(userUuid, "/secondaryDevice"));
+  const currentDeviceStatusRef = isSecondaryDevice ? secondaryDeviceStatusRef : primaryDeviceStatusRef;
+  update(currentDeviceStatusRef, {
+    allPermissionGranted
+  });
+  onDisconnect(currentDeviceStatusRef).update({
+    connected: false
+  });
+  const unsubscribePrimary = onValue(primaryDeviceStatusRef, snapshot => {
+    const val = snapshot.val();
+    onPrimaryDeviceStatusChange(Boolean(val === null || val === void 0 ? void 0 : val.connected));
+  });
+  const unsubscribeSecondary = onValue(secondaryDeviceStatusRef, snapshot => {
+    const val = snapshot.val();
+    onSecondaryDeviceStatusChange(Boolean(val === null || val === void 0 ? void 0 : val.connected), val === null || val === void 0 ? void 0 : val.allPermissionGranted);
+  });
+  return () => {
+    unsubscribePrimary();
+    unsubscribeSecondary();
+  };
+};
+exports.setupDeviceStatusListeners = setupDeviceStatusListeners;

package/package.json

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