dce-reactkit 3.2.1 → 3.2.2-beta.2

package/dist/cjs/types/constants/LOG_REVIEW_ROUTE_PATH_PREFIX.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+declare const LOG_REVIEW_ROUTE_PATH_PREFIX: string;
+export default LOG_REVIEW_ROUTE_PATH_PREFIX;

package/dist/cjs/types/constants/LOG_REVIEW_STATUS_ROUTE.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Route for checking the status of the current user's
+ *   access to log review
+ * @author Gabe Abrams
+ */
+declare const LOG_REVIEW_STATUS_ROUTE: string;
+export default LOG_REVIEW_STATUS_ROUTE;

package/dist/cjs/types/helpers/canReviewLogs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if the current user can review logs
+ * @author Gabe Abrams
+ * @returns true if current user can review logs
+ */
+declare const canReviewLogs: () => Promise<boolean>;
+export default canReviewLogs;

package/dist/cjs/types/helpers/genCSV.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generate a CSV file
+ * @author Gabe Abrams
+ * @param data list of row data in the form of json objects
+ * @param columns list of columns to include in the csv
+ * @returns multiline csv string
+ */
+declare const genCSV: (data: {
+    [k: string]: any;
+}[], columns: {
+    title: string;
+    param: string;
+}[]) => string;
+export default genCSV;

package/dist/cjs/types/helpers/getMonthName.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Get the name of a month given the month number (1 = January, etc.)
+ *   If an invalid number is provided, we will treat it like January
+ * @author Gabe Abrams
+ * @param month the number of the month
+ * @returns object containing multiple month name formats:
+ *   { short, full } where short will look like "Jan" and full will look like
+ *   "January"
+ */
+declare const getMonthName: (month: number) => {
+    short: string;
+    full: string;
+};
+export default getMonthName;

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

@@ -13,6 +13,9 @@ import PopFailureMark from './components/PopFailureMark';
 import PopPendingMark from './components/PopPendingMark';
 import CopiableBox from './components/CopiableBox';
 import ItemPicker from './components/ItemPicker';
+import LogReviewer from './components/LogReviewer';
+import IntelliTable from './components/IntelliTable';
+import CSVDownloadButton from './components/CSVDownloadButton';
 import ErrorWithCode from './errors/ErrorWithCode';
 import MINUTE_IN_MS from './constants/MINUTE_IN_MS';
 import HOUR_IN_MS from './constants/HOUR_IN_MS';
@@ -43,6 +46,8 @@ import onlyKeepLetters from './helpers/onlyKeepLetters';
 import parallelLimit from './helpers/parallelLimit';
 import logClientEvent from './helpers/logClientEvent';
 import initLogCollection from './server/initLogCollection';
+import getMonthName from './helpers/getMonthName';
+import genCSV from './helpers/genCSV';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -55,5 +60,7 @@ import LogType from './types/LogType';
 import LogSource from './types/LogSource';
 import LogAction from './types/LogAction';
 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, 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, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, 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, 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,10 +25,18 @@ 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
+ *   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
+ *   userIds are allowed to review logs. If a dce-mango collection, only
+ *   Canvas admins with entries in that collection ({ userId, ...}) are allowed
+ *   to review logs
  */
 declare const initServer: (opts: {
     app: any;
     getLaunchInfo: GetLaunchInfoFunction;
     logCollection?: any;
+    logReviewAdmins?: (number[] | any);
 }) => void;
 export default initServer;

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

@@ -0,0 +1,12 @@
+import ParamType from './ParamType';
+/**
+ * Column description for a column in the IntelliTable
+ * @author Gabe Abrams
+ */
+declare type IntelliTableColumn = {
+    title: string;
+    param: string;
+    type: (ParamType.Boolean | ParamType.Float | ParamType.Int | ParamType.String | ParamType.JSON);
+    startsHidden?: boolean;
+};
+export default IntelliTableColumn;

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

@@ -7,6 +7,7 @@ declare const LogBuiltInMetadata: {
         Uncategorized: string;
         ServerRenderedErrorPage: string;
         ServerEndpointError: string;
+        ClientFatalError: string;
     };
     Target: {
         NoSpecificTarget: string;

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

@@ -0,0 +1,19 @@
+/**
+ * Type of a LogMetadata file
+ * @author Gabe Abrams
+ */
+declare type LogMetadataType = {
+    Context?: {
+        [k: string]: (string | {
+            _: string;
+            [k: string]: string;
+        });
+    };
+    Tag?: {
+        [k: string]: string;
+    };
+    Target?: {
+        [k: string]: string;
+    };
+};
+export default LogMetadataType;

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

@@ -12,6 +12,7 @@ declare enum ReactKitErrorCode {
     NoCACCLSendRequestFunction = "DRK7",
     NoCACCLGetLaunchInfoFunction = "DRK8",
     NotTTM = "DRK9",
-    NotAdmin = "DRK10"
+    NotAdmin = "DRK10",
+    NotAllowedToReviewLogs = "DRK11"
 }
 export default ReactKitErrorCode;