dce-reactkit 3.2.1 → 3.2.2-beta.10

package/dist/esm/types/components/LogReviewer.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Log reviewer panel that allows users (must be approved admins) to
+ *   review logs written by dce-reactkit
+ * @author Gabe Abrams
+ */
+import React from 'react';
+import LogMetadataType from '../types/LogMetadataType';
+declare type Props = {
+    LogMetadata: LogMetadataType;
+    onClose: () => void;
+};
+declare const LogReviewer: React.FC<Props>;
+export default LogReviewer;

package/dist/esm/types/components/SimpleDateChooser.d.ts

@@ -17,6 +17,7 @@ declare type Props = {
      */
     onChange: (month: number, day: number, year: number) => void;
     numMonthsToShow?: number;
+    chooseFromPast?: boolean;
 };
 declare const SimpleDateChooser: React.FC<Props>;
 export default SimpleDateChooser;

package/dist/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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,9 @@ 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 canReviewLogs from './helpers/canReviewLogs';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -55,5 +61,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, 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/esm/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] 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/esm/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/esm/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/esm/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/esm/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;

package/dist/index.d.ts

@@ -22,7 +22,7 @@ declare enum Variant {
  * @author Gabe Abrams
  */
 
-declare type Props$d = {
+declare type Props$g = {
     children: React.ReactNode;
     sendRequest: SendRequestFunction;
     dark?: boolean;
@@ -80,7 +80,7 @@ declare const confirm: (title: string, text: string, opts?: {
  * @param [errorTitle] title of the error box
  */
 declare const showFatalError: (error: any, errorTitle?: string) => undefined;
-declare const AppWrapper: React.FC<Props$d>;
+declare const AppWrapper: React.FC<Props$g>;
 
 /**
  * Loading spinner/indicator
@@ -93,12 +93,12 @@ declare const LoadingSpinner: () => JSX.Element;
  * @author Gabe Abrams
  */
 
-declare type Props$c = {
+declare type Props$f = {
     error: any;
     title?: string;
     onClose?: () => void;
 };
-declare const ErrorBox: React.FC<Props$c>;
+declare const ErrorBox: React.FC<Props$f>;
 
 /**
  * Types of buttons in the modal
@@ -149,7 +149,7 @@ declare enum ModalType {
  * @author Gabe Abrams
  */
 
-declare type Props$b = {
+declare type Props$e = {
     type?: ModalType;
     size?: ModalSize;
     title?: React.ReactNode;
@@ -178,27 +178,27 @@ declare type Props$b = {
     confirmVariant?: Variant;
     onTopOfOtherModals?: boolean;
 };
-declare const Modal: React.FC<Props$b>;
+declare const Modal: React.FC<Props$e>;
 
 /**
  * A box with a tab on the top that holds buttons and other content
  * @author Gabe Abrams
  */
 
-declare type Props$a = {
+declare type Props$d = {
     title: React.ReactNode;
     children: React.ReactNode;
     noBottomMargin?: boolean;
     noBottomPadding?: boolean;
 };
-declare const TabBox: React.FC<Props$a>;
+declare const TabBox: React.FC<Props$d>;
 
 /**
  * A radio selection button
  * @author Gabe Abrams
  */
 
-declare type Props$9 = {
+declare type Props$c = {
     text: string;
     onSelected: () => void;
     ariaLabel: string;
@@ -210,14 +210,14 @@ declare type Props$9 = {
     unselectedVariant?: Variant;
     small?: boolean;
 };
-declare const RadioButton: React.FC<Props$9>;
+declare const RadioButton: React.FC<Props$c>;
 
 /**
  * A checkbox button
  * @author Gabe Abrams
  */
 
-declare type Props$8 = {
+declare type Props$b = {
     text: string;
     onChanged: (checked: boolean) => void;
     ariaLabel: string;
@@ -231,26 +231,27 @@ declare type Props$8 = {
     small?: boolean;
     dashed?: boolean;
 };
-declare const CheckboxButton: React.FC<Props$8>;
+declare const CheckboxButton: React.FC<Props$b>;
 
 /**
  * Input group with a title and space for buttons
  * @author Gabe Abrams
  */
 
-declare type Props$7 = {
+declare type Props$a = {
     label: string;
     minLabelWidth?: string;
     children: React.ReactNode;
+    className?: string;
 };
-declare const ButtonInputGroup: React.FC<Props$7>;
+declare const ButtonInputGroup: React.FC<Props$a>;
 
 /**
  * A very simple, lightweight date chooser
  * @author Gabe Abrams
  */
 
-declare type Props$6 = {
+declare type Props$9 = {
     ariaLabel: string;
     name: string;
     month: number;
@@ -264,61 +265,62 @@ declare type Props$6 = {
      */
     onChange: (month: number, day: number, year: number) => void;
     numMonthsToShow?: number;
+    chooseFromPast?: boolean;
 };
-declare const SimpleDateChooser: React.FC<Props$6>;
+declare const SimpleDateChooser: React.FC<Props$9>;
 
 /**
  * Drawer container
  * @author Gabe Abrams
  */
 
-declare type Props$5 = {
+declare type Props$8 = {
     children: React.ReactNode;
 };
-declare const Drawer: React.FC<Props$5>;
+declare const Drawer: React.FC<Props$8>;
 
 /**
  * Success checkmark that pops into view
  * @author Gabe Abrams
  */
 
-declare type Props$4 = {
+declare type Props$7 = {
     sizeRem?: number;
     circleVariant?: string;
     checkVariant?: string;
 };
-declare const PopSuccessMark: React.FC<Props$4>;
+declare const PopSuccessMark: React.FC<Props$7>;
 
 /**
  * Failure x mark that pops into view
  * @author Gabe Abrams
  */
 
-declare type Props$3 = {
+declare type Props$6 = {
     sizeRem?: number;
     circleVariant?: string;
     xVariant?: string;
 };
-declare const PopFailureMark: React.FC<Props$3>;
+declare const PopFailureMark: React.FC<Props$6>;
 
 /**
  * Failure pending that pops into view
  * @author Gabe Abrams
  */
 
-declare type Props$2 = {
+declare type Props$5 = {
     sizeRem?: number;
     circleVariant?: string;
     hourglassVariant?: string;
 };
-declare const PopPendingMark: React.FC<Props$2>;
+declare const PopPendingMark: React.FC<Props$5>;
 
 /**
  * Copiable text box
  * @author Gabe Abrams
  */
 
-declare type Props$1 = {
+declare type Props$4 = {
     text: string;
     maxTextWidthRem?: number;
     label?: string;
@@ -330,7 +332,7 @@ declare type Props$1 = {
     textAreaId?: string;
     copyButtonId?: string;
 };
-declare const CopiableBox: React.FC<Props$1>;
+declare const CopiableBox: React.FC<Props$4>;
 
 /**
  * An item that can be chosen (for use within ItemPicker)
@@ -353,7 +355,7 @@ declare type PickableItem = ({
  * @author Yuen Ler Chow
  */
 
-declare type Props = {
+declare type Props$3 = {
     title: string;
     items: PickableItem[];
     /**
@@ -362,8 +364,103 @@ declare type Props = {
      *   values updated
      */
     onChanged: (updatedItems: PickableItem[]) => void;
+    noBottomMargin?: boolean;
+};
+declare const ItemPicker: React.FC<Props$3>;
+
+/**
+ * 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;
+    };
 };
-declare const ItemPicker: React.FC<Props>;
+
+/**
+ * Log reviewer panel that allows users (must be approved admins) to
+ *   review logs written by dce-reactkit
+ * @author Gabe Abrams
+ */
+
+declare type Props$2 = {
+    LogMetadata: LogMetadataType;
+    onClose: () => void;
+};
+declare const LogReviewer: React.FC<Props$2>;
+
+/**
+ * Server-side API param types
+ * @author Gabe Abrams
+ */
+declare enum ParamType {
+    Boolean = "boolean",
+    BooleanOptional = "boolean-optional",
+    Float = "float",
+    FloatOptional = "float-optional",
+    Int = "int",
+    IntOptional = "int-optional",
+    JSON = "json",
+    JSONOptional = "json-optional",
+    String = "string",
+    StringOptional = "string-optional"
+}
+
+/**
+ * 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;
+};
+
+/**
+ * Intelligent table
+ * @author Gabe Abrams
+ */
+
+declare type Props$1 = {
+    title: string;
+    id: string;
+    data: {
+        id: string | number;
+        [k: string]: any;
+    }[];
+    columns: IntelliTableColumn[];
+};
+declare const IntelliTable: React.FC<Props$1>;
+
+/**
+ * Button for downloading a csv file
+ * @author Gabe Abrams
+ */
+
+declare type Props = {
+    filename: string;
+    csv: string;
+    id?: string;
+    className?: string;
+    ariaLabel?: string;
+    style?: {
+        [k: string]: any;
+    };
+    onClick?: () => void;
+    children?: React.ReactNode;
+};
+declare const CSVDownloadButton: React.FC<Props>;
 
 /**
  * An error with a code
@@ -498,23 +595,6 @@ declare const visitServerEndpoint: (opts: {
     } | undefined;
 }) => Promise<any>;
 
-/**
- * Server-side API param types
- * @author Gabe Abrams
- */
-declare enum ParamType {
-    Boolean = "boolean",
-    BooleanOptional = "boolean-optional",
-    Float = "float",
-    FloatOptional = "float-optional",
-    Int = "int",
-    IntOptional = "int-optional",
-    JSON = "json",
-    JSONOptional = "json-optional",
-    String = "string",
-    StringOptional = "string-optional"
-}
-
 /**
  * Allowed log levels
  * @author Gabe Abrams
@@ -744,11 +824,19 @@ declare type GetLaunchInfoFunction = (req: 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] 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;
 
 /**
@@ -861,6 +949,41 @@ declare const logClientEvent: LogFunction;
  */
 declare const initLogCollection: (Collection: any) => any;
 
+/**
+ * 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;
+};
+
+/**
+ * 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;
+
+/**
+ * Check if the current user can review logs
+ * @author Gabe Abrams
+ * @returns true if current user can review logs
+ */
+declare const canReviewLogs: () => Promise<boolean>;
+
 /**
  * List of error codes built into the react kit
  * @author Gabe Abrams
@@ -875,7 +998,8 @@ declare enum ReactKitErrorCode {
     NoCACCLSendRequestFunction = "DRK7",
     NoCACCLGetLaunchInfoFunction = "DRK8",
     NotTTM = "DRK9",
-    NotAdmin = "DRK10"
+    NotAdmin = "DRK10",
+    NotAllowedToReviewLogs = "DRK11"
 }
 
 /**
@@ -901,10 +1025,11 @@ declare const LogBuiltInMetadata: {
         Uncategorized: string;
         ServerRenderedErrorPage: string;
         ServerEndpointError: string;
+        ClientFatalError: string;
     };
     Target: {
         NoSpecificTarget: string;
     };
 };
 
-export { AppWrapper, ButtonInputGroup, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genRouteHandler, getHumanReadableDate, 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, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.2.1",
+  "version": "3.2.2-beta.10",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",