dce-reactkit 4.0.1 → 4.1.0

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

@@ -0,0 +1,13 @@
+import React from 'react';
+type Props = {
+    currentPage: number;
+    numPages: number;
+    loading?: boolean;
+    /**
+     * Handler for when page is changed
+     * @param page - the new page number
+     */
+    onPageChanged: (page: number) => void;
+};
+declare const Pagination: React.FC<Props>;
+export default Pagination;

package/dist/esm/types/constants/LOG_REVIEW_GET_LOGS_ROUTE.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Path of the route for getting logs for log review
+ * @author Gabe Abrams
+ */
+declare const LOG_REVIEW_GET_LOGS_ROUTE: string;
+export default LOG_REVIEW_GET_LOGS_ROUTE;

package/dist/esm/types/helpers/cloneDeep.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Deeply clones an object
+ * @author Yuen Ler Chow
+ * @param obj the object to clone
+ * @returns a deep clone of the object
+ */
+declare const cloneDeep: <T>(obj: T) => T;
+export default cloneDeep;

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

@@ -30,6 +30,7 @@ import DAY_IN_MS from './constants/DAY_IN_MS';
 import LOG_REVIEW_ROUTE_PATH_PREFIX from './constants/LOG_REVIEW_ROUTE_PATH_PREFIX';
 import LOG_ROUTE_PATH from './constants/LOG_ROUTE_PATH';
 import LOG_REVIEW_STATUS_ROUTE from './constants/LOG_REVIEW_STATUS_ROUTE';
+import LOG_REVIEW_GET_LOGS_ROUTE from './constants/LOG_REVIEW_GET_LOGS_ROUTE';
 import DynamicWord from './dynamicConstants/DynamicWord';
 import initClient from './helpers/initClient';
 import abbreviate from './helpers/abbreviate';
@@ -77,6 +78,7 @@ import someAsync from './helpers/asyncArrayFunctions/someAsync';
 import capitalize from './helpers/capitalize';
 import shuffleArray from './helpers/shuffleArray';
 import getWordCount from './helpers/getWordCount';
+import cloneDeep from './helpers/cloneDeep';
 import ParamType from './types/ParamType';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
@@ -97,8 +99,9 @@ import LogLevel from './types/LogLevel';
 import IntelliTableColumn from './types/IntelliTableColumn';
 import DropdownItemType from './types/DropdownItemType';
 import ReactKitErrorCode from './types/ReactKitErrorCode';
+import LogReviewerFilterState from './types/LogReviewerFilterState';
 import PickableItem from './components/ItemPicker/types/PickableItem';
 import DBEntry from './components/DBEntryManagerPanel/types/DBEntry';
 import DBEntryField from './components/DBEntryManagerPanel/types/DBEntryField';
 import DBEntryFieldType from './components/DBEntryManagerPanel/types/DBEntryFieldType';
-export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, SimpleTimeChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, Dropdown, alert, prompt, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_ROUTE_PATH, LOG_REVIEW_STATUS_ROUTE, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, getWordCount, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, ParamType, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, LogTypeSpecificInfo, LogMainInfo, LogSourceSpecificInfo, LogLevel, IntelliTableColumn, DropdownItemType, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, SimpleTimeChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, Dropdown, alert, prompt, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_ROUTE_PATH, LOG_REVIEW_STATUS_ROUTE, LOG_REVIEW_GET_LOGS_ROUTE, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, getWordCount, cloneDeep, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, ParamType, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, LogTypeSpecificInfo, LogMainInfo, LogSourceSpecificInfo, LogLevel, IntelliTableColumn, DropdownItemType, LogReviewerFilterState, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, };

package/dist/esm/types/types/LogReviewerFilterState/ActionErrorFilterState.d.ts

@@ -0,0 +1,17 @@
+import LogType from '../LogType';
+/**
+ * Action filter state (only relevant for action logs)
+ * @author Yuen Ler Chow
+ */
+type ActionErrorFilterState = {
+    type: LogType | undefined;
+    errorMessage: string;
+    errorCode: string;
+    target: {
+        [k: string]: boolean;
+    };
+    action: {
+        [k: string]: boolean;
+    };
+};
+export default ActionErrorFilterState;

package/dist/esm/types/types/LogReviewerFilterState/AdvancedFilterState.d.ts

@@ -0,0 +1,21 @@
+import LogSource from '../LogSource';
+/**
+ * Advanced filter state
+ * @author Yuen Ler Chow
+ */
+type AdvancedFilterState = {
+    userFirstName: string;
+    userLastName: string;
+    userEmail: string;
+    userId: string;
+    includeLearners: boolean;
+    includeTTMs: boolean;
+    includeAdmins: boolean;
+    courseId: string;
+    courseName: string;
+    isMobile: (true | false | undefined);
+    source: LogSource | undefined;
+    routePath: string;
+    routeTemplate: string;
+};
+export default AdvancedFilterState;

package/dist/esm/types/types/LogReviewerFilterState/ContextFilterState.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Context filter state
+ * @author Yuen Ler Chow
+ */
+type ContextFilterState = {
+    [k: string]: (boolean | {
+        [k: string]: boolean;
+    });
+};
+export default ContextFilterState;

package/dist/esm/types/types/LogReviewerFilterState/DateFilterState.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Date filter state
+ * @author Yuen Ler Chow
+ */
+type DateFilterState = {
+    startDate: {
+        year: number;
+        month: number;
+        day: number;
+    };
+    endDate: {
+        year: number;
+        month: number;
+        day: number;
+    };
+};
+export default DateFilterState;

package/dist/esm/types/types/LogReviewerFilterState/TagFilterState.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Tag filter state
+ * @author Yuen Ler Chow
+ */
+type TagFilterState = {
+    [k: string]: boolean;
+};
+export default TagFilterState;

package/dist/esm/types/types/LogReviewerFilterState/index.d.ts

@@ -0,0 +1,17 @@
+import DateFilterState from './DateFilterState';
+import ContextFilterState from './ContextFilterState';
+import TagFilterState from './TagFilterState';
+import ActionErrorFilterState from './ActionErrorFilterState';
+import AdvancedFilterState from './AdvancedFilterState';
+/**
+ * A bundle of filter state objects for each type of filter
+ * @author Gabe Abrams
+ */
+type LogReviewerFilterState = {
+    dateFilterState: DateFilterState;
+    contextFilterState: ContextFilterState;
+    tagFilterState: TagFilterState;
+    actionErrorFilterState: ActionErrorFilterState;
+    advancedFilterState: AdvancedFilterState;
+};
+export default LogReviewerFilterState;

package/dist/index.d.ts

@@ -815,6 +815,12 @@ declare const LOG_ROUTE_PATH: string;
  */
 declare const LOG_REVIEW_STATUS_ROUTE: string;
 
+/**
+ * Path of the route for getting logs for log review
+ * @author Gabe Abrams
+ */
+declare const LOG_REVIEW_GET_LOGS_ROUTE: string;
+
 /**
  * Dynamic words determined by the user's platform
  * @author Gabe Abrams
@@ -1534,6 +1540,14 @@ declare const shuffleArray: <T>(arr: T[]) => T[];
  */
 declare const getWordCount: (text: string) => number;
 
+/**
+ * Deeply clones an object
+ * @author Yuen Ler Chow
+ * @param obj the object to clone
+ * @returns a deep clone of the object
+ */
+declare const cloneDeep: <T>(obj: T) => T;
+
 /**
  * Days of the week
  * @author Gabe Abrams
@@ -1577,4 +1591,87 @@ declare enum ReactKitErrorCode {
     SimpleDateChooserInvalidNumMonths = "DRK36"
 }
 
-export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, Dropdown, DropdownItemType, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_REVIEW_STATUS_ROUTE, LOG_ROUTE_PATH, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogLevel, LogMainInfo, LogMetadataType, LogReviewer, LogSource, LogSourceSpecificInfo, LogType, LogTypeSpecificInfo, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, SimpleTimeChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addFatalErrorHandler, alert, avg, canReviewLogs, capitalize, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, getWordCount, idify, initClient, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, prompt, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };
+/**
+ * Date filter state
+ * @author Yuen Ler Chow
+ */
+type DateFilterState = {
+    startDate: {
+        year: number;
+        month: number;
+        day: number;
+    };
+    endDate: {
+        year: number;
+        month: number;
+        day: number;
+    };
+};
+
+/**
+ * Context filter state
+ * @author Yuen Ler Chow
+ */
+type ContextFilterState = {
+    [k: string]: (boolean | {
+        [k: string]: boolean;
+    });
+};
+
+/**
+ * Tag filter state
+ * @author Yuen Ler Chow
+ */
+type TagFilterState = {
+    [k: string]: boolean;
+};
+
+/**
+ * Action filter state (only relevant for action logs)
+ * @author Yuen Ler Chow
+ */
+type ActionErrorFilterState = {
+    type: LogType | undefined;
+    errorMessage: string;
+    errorCode: string;
+    target: {
+        [k: string]: boolean;
+    };
+    action: {
+        [k: string]: boolean;
+    };
+};
+
+/**
+ * Advanced filter state
+ * @author Yuen Ler Chow
+ */
+type AdvancedFilterState = {
+    userFirstName: string;
+    userLastName: string;
+    userEmail: string;
+    userId: string;
+    includeLearners: boolean;
+    includeTTMs: boolean;
+    includeAdmins: boolean;
+    courseId: string;
+    courseName: string;
+    isMobile: (true | false | undefined);
+    source: LogSource | undefined;
+    routePath: string;
+    routeTemplate: string;
+};
+
+/**
+ * A bundle of filter state objects for each type of filter
+ * @author Gabe Abrams
+ */
+type LogReviewerFilterState = {
+    dateFilterState: DateFilterState;
+    contextFilterState: ContextFilterState;
+    tagFilterState: TagFilterState;
+    actionErrorFilterState: ActionErrorFilterState;
+    advancedFilterState: AdvancedFilterState;
+};
+
+export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, Dropdown, DropdownItemType, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LOG_REVIEW_GET_LOGS_ROUTE, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_REVIEW_STATUS_ROUTE, LOG_ROUTE_PATH, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogLevel, LogMainInfo, LogMetadataType, LogReviewer, LogReviewerFilterState, LogSource, LogSourceSpecificInfo, LogType, LogTypeSpecificInfo, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, SimpleTimeChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addFatalErrorHandler, alert, avg, canReviewLogs, capitalize, ceilToNumDecimals, cloneDeep, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, getWordCount, idify, initClient, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, prompt, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -24,6 +24,7 @@
   },
   "homepage": "https://github.com/harvard-edtech/dce-reactkit#readme",
   "dependencies": {
+    "nanoclone": "^1.0.2",
     "react-select": "^5.7.3"
   },
   "peerDependencies": {