dce-reactkit 3.2.2-beta.2 → 3.2.2-beta.4

package/dist/cjs/types/index.d.ts

@@ -48,6 +48,7 @@ import logClientEvent from './helpers/logClientEvent';
 import initLogCollection from './server/initLogCollection';
 import getMonthName from './helpers/getMonthName';
 import genCSV from './helpers/genCSV';
+import canReviewLogs from './helpers/canReviewLogs';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -63,4 +64,4 @@ import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 import LogMetadataType from './types/LogMetadataType';
 import IntelliTableColumn from './types/IntelliTableColumn';
 import PickableItem from './components/ItemPicker/types/PickableItem';
-export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, ParamType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, ParamType, };

package/dist/cjs/types/server/initServer.d.ts

@@ -25,7 +25,7 @@ export declare const internalGetLogCollection: () => any;
  * @param opts.getLaunchInfo CACCL LTI's get launch info function
  * @param [opts.logCollection] mongo collection from dce-mango to use for
  *   storing logs. If none is included, logs are written to the console
- * @param [opts.logReviewAdmins=all admins] info on which admins can review
+ * @param [opts.logReviewAdmins=all] info on which admins can review
  *   logs from the client. If not included, all Canvas admins are allowed to
  *   review logs. If null, no Canvas admins are allowed to review logs.
  *   If an array of Canvas userIds (numbers), only Canvas admins with those

package/dist/esm/index.js

@@ -3884,7 +3884,7 @@ const padZerosLeft = (num, numDigits) => {
  *   access to log review
  * @author Gabe Abrams
  */
-const LOG_REVIEW_STATUS_ROUTE = `/admin${ROUTE_PATH_PREFIX}/logs/access`;
+const LOG_REVIEW_STATUS_ROUTE = `${ROUTE_PATH_PREFIX}/logs/access_allowed`;
 
 // Stored copy of caccl functions
 let _cacclGetLaunchInfo;
@@ -3926,7 +3926,7 @@ const internalGetLogCollection = () => {
  * @param opts.getLaunchInfo CACCL LTI's get launch info function
  * @param [opts.logCollection] mongo collection from dce-mango to use for
  *   storing logs. If none is included, logs are written to the console
- * @param [opts.logReviewAdmins=all admins] info on which admins can review
+ * @param [opts.logReviewAdmins=all] info on which admins can review
  *   logs from the client. If not included, all Canvas admins are allowed to
  *   review logs. If null, no Canvas admins are allowed to review logs.
  *   If an array of Canvas userIds (numbers), only Canvas admins with those
@@ -4009,71 +4009,79 @@ const initServer = (opts) => {
     /*----------------------------------------*/
     /*              Log Reviewer              */
     /*----------------------------------------*/
-    if (opts.logReviewAdmins !== null) {
-        /**
-         * Check if a given user is allowed to review logs
-         * @author Gabe Abrams
-         * @param userId the id of the user
-         * @returns true if the user can review logs
-         */
-        const canReviewLogs = (userId) => __awaiter(void 0, void 0, void 0, function* () {
-            try {
-                // Array of userIds
-                if (Array.isArray(opts.logReviewAdmins)) {
-                    return opts.logReviewAdmins.some((allowedId) => {
-                        return (userId === allowedId);
-                    });
-                }
-                // Must be a collection
-                const matches = yield opts.logReviewAdmins.find({ userId });
-                // Make sure at least one entry matches
-                return matches.length > 0;
+    /**
+     * Check if a given user is allowed to review logs
+     * @author Gabe Abrams
+     * @param userId the id of the user
+     * @param isAdmin if true, the user is an admin
+     * @returns true if the user can review logs
+     */
+    const canReviewLogs = (userId, isAdmin) => __awaiter(void 0, void 0, void 0, function* () {
+        // Immediately deny access if user is not an admin
+        if (!isAdmin) {
+            return false;
+        }
+        // If all admins are allowed, we're done
+        if (!opts.logReviewAdmins) {
+            return true;
+        }
+        // Do a dynamic check
+        try {
+            // Array of userIds
+            if (Array.isArray(opts.logReviewAdmins)) {
+                return opts.logReviewAdmins.some((allowedId) => {
+                    return (userId === allowedId);
+                });
             }
-            catch (err) {
-                // If an error occurred, simply return false
-                return false;
+            // Must be a collection
+            const matches = yield opts.logReviewAdmins.find({ userId });
+            // Make sure at least one entry matches
+            return matches.length > 0;
+        }
+        catch (err) {
+            // If an error occurred, simply return false
+            return false;
+        }
+    });
+    /**
+     * Check if the current user has access to logs
+     * @author Gabe Abrams
+     * @returns {boolean} true if user has access
+     */
+    opts.app.get(LOG_REVIEW_STATUS_ROUTE, genRouteHandler({
+        handler: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
+            const { userId, isAdmin } = params;
+            const canReview = yield canReviewLogs(userId, isAdmin);
+            return canReview;
+        }),
+    }));
+    /**
+     * Get all logs for a certain month
+     * @author Gabe Abrams
+     * @param {number} year the year to query (e.g. 2022)
+     * @param {number} month the month to query (e.g. 1 = January)
+     * @returns {Log[]} list of logs from the given month
+     */
+    opts.app.post(`${LOG_REVIEW_ROUTE_PATH_PREFIX}/years/:year/months/:month`, genRouteHandler({
+        paramTypes: {
+            year: ParamType$1.Int,
+            month: ParamType$1.Int,
+        },
+        handler: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
+            // Get user info
+            const { userId, isAdmin } = params;
+            // Validate user
+            // isAdmin is already checked because path starts with '/admin'
+            const canReview = yield canReviewLogs(userId, isAdmin);
+            if (!canReview) {
+                throw new ErrorWithCode('You cannot access this resource because you do not have the appropriate permissions.', ReactKitErrorCode$1.NotAllowedToReviewLogs);
             }
-        });
-        /**
-         * Check if the current user has access to logs
-         * @author Gabe Abrams
-         * @returns {boolean} true if user has access
-         */
-        opts.app.get(LOG_REVIEW_STATUS_ROUTE, genRouteHandler({
-            handler: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
-                const { userId } = params;
-                const canReview = yield canReviewLogs(userId);
-                return canReview;
-            }),
-        }));
-        /**
-         * Get all logs for a certain month
-         * @author Gabe Abrams
-         * @param {number} year the year to query (e.g. 2022)
-         * @param {number} month the month to query (e.g. 1 = January)
-         * @returns {Log[]} list of logs from the given month
-         */
-        opts.app.post(`${LOG_REVIEW_ROUTE_PATH_PREFIX}/years/:year/months/:month`, genRouteHandler({
-            paramTypes: {
-                year: ParamType$1.Int,
-                month: ParamType$1.Int,
-            },
-            handler: ({ params }) => __awaiter(void 0, void 0, void 0, function* () {
-                // Get user info
-                const { userId } = params;
-                // Validate user
-                // isAdmin is already checked because path starts with '/admin'
-                const canReview = yield canReviewLogs(userId);
-                if (!canReview) {
-                    throw new ErrorWithCode('You cannot access this resource because you do not have the appropriate permissions.', ReactKitErrorCode$1.NotAllowedToReviewLogs);
-                }
-                // Query for logs
-                const logs = yield _logCollection.find({ userId });
-                // Return logs
-                return logs;
-            }),
-        }));
-    }
+            // Query for logs
+            const logs = yield _logCollection.find({ userId });
+            // Return logs
+            return logs;
+        }),
+    }));
 };
 
 // Import shared types
@@ -5124,6 +5132,31 @@ const initLogCollection = (Collection) => {
     });
 };
 
+// Cache user's ability
+let canReview = undefined;
+/**
+ * Check if the current user can review logs
+ * @author Gabe Abrams
+ * @returns true if current user can review logs
+ */
+const canReviewLogs = () => __awaiter(void 0, void 0, void 0, function* () {
+    // If cached, use that value
+    if (canReview !== undefined) {
+        return canReview;
+    }
+    // Ask on server
+    try {
+        canReview = !!(yield visitServerEndpoint({
+            path: LOG_REVIEW_STATUS_ROUTE,
+            method: 'GET',
+        }));
+    }
+    catch (err) {
+        canReview = false;
+    }
+    return canReview;
+});
+
 /**
  * Days of the week
  * @author Gabe Abrams
@@ -5140,5 +5173,5 @@ var DayOfWeek;
 })(DayOfWeek || (DayOfWeek = {}));
 var DayOfWeek$1 = DayOfWeek;
 
-export { AppWrapper, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek$1 as DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, ItemPicker, LoadingSpinner, LogAction$1 as LogAction, LogBuiltInMetadata, LogReviewer, LogSource$1 as LogSource, LogType$1 as LogType, MINUTE_IN_MS, Modal, ModalButtonType$1 as ModalButtonType, ModalSize$1 as ModalSize, ModalType$1 as ModalType, ParamType$1 as ParamType, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode$1 as ReactKitErrorCode, SimpleDateChooser, TabBox, Variant$1 as Variant, abbreviate, alert$1 as alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genCSV, genRouteHandler, getHumanReadableDate, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initLogCollection, initServer, logClientEvent, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, visitServerEndpoint, waitMs };
+export { AppWrapper, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek$1 as DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, ItemPicker, LoadingSpinner, LogAction$1 as LogAction, LogBuiltInMetadata, LogReviewer, LogSource$1 as LogSource, LogType$1 as LogType, MINUTE_IN_MS, Modal, ModalButtonType$1 as ModalButtonType, ModalSize$1 as ModalSize, ModalType$1 as ModalType, ParamType$1 as ParamType, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode$1 as ReactKitErrorCode, SimpleDateChooser, TabBox, Variant$1 as Variant, abbreviate, alert$1 as alert, avg, canReviewLogs, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genCSV, genRouteHandler, getHumanReadableDate, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initLogCollection, initServer, logClientEvent, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, visitServerEndpoint, waitMs };
 //# sourceMappingURL=index.js.map