dce-reactkit 4.3.4 → 5.0.0

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

@@ -1,17 +0,0 @@
-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/cjs/types/types/LogReviewerFilterState/AdvancedFilterState.d.ts

@@ -1,21 +0,0 @@
-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/cjs/types/types/LogReviewerFilterState/ContextFilterState.d.ts

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

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

@@ -1,17 +0,0 @@
-/**
- * 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/cjs/types/types/LogReviewerFilterState/TagFilterState.d.ts

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

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

@@ -1,17 +0,0 @@
-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/cjs/types/types/LogSource.d.ts

@@ -1,9 +0,0 @@
-/**
- * Source of a log event
- * @author Gabe Abrams
- */
-declare enum LogSource {
-    Client = "client",
-    Server = "server"
-}
-export default LogSource;

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

@@ -1,9 +0,0 @@
-/**
- * Type of a log event
- * @author Gabe Abrams
- */
-declare enum LogType {
-    Action = "action",
-    Error = "error"
-}
-export default LogType;

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

@@ -1,17 +0,0 @@
-/**
- * Server-side API param types
- * @author Gabe Abrams
- */
-declare enum ParamType {
-    Boolean = "Boolean",
-    BooleanOptional = "BooleanOptional",
-    Float = "Float",
-    FloatOptional = "FloatOptional",
-    Int = "Int",
-    IntOptional = "IntOptional",
-    JSON = "JSON",
-    JSONOptional = "JSONOptional",
-    String = "String",
-    StringOptional = "StringOptional"
-}
-export default ParamType;

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

@@ -1,14 +0,0 @@
-/**
- * List of error codes built into the react kit
- * @author Gabe Abrams
- */
-declare enum ReactKitErrorCode {
-    NoResponse = "DRK1",
-    NoCode = "DRK2",
-    SessionExpired = "DRK3",
-    NoCACCLSendRequestFunction = "DRK7",
-    SimpleDateChooserInvalidDateRange = "DRK35",
-    SimpleDateChooserInvalidNumMonths = "DRK36",
-    ETTimestampInvalid = "DRK37"
-}
-export default ReactKitErrorCode;

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

@@ -1,6 +0,0 @@
-/**
- * One day in ms
- * @author Gabe Abrams
- */
-declare const DAY_IN_MS = 86400000;
-export default DAY_IN_MS;

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

@@ -1,6 +0,0 @@
-/**
- * One hour in ms
- * @author Gabe Abrams
- */
-declare const HOUR_IN_MS = 3600000;
-export default HOUR_IN_MS;

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

@@ -1,6 +0,0 @@
-/**
- * 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/constants/LOG_REVIEW_ROUTE_PATH_PREFIX.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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

@@ -1,7 +0,0 @@
-/**
- * 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/constants/LOG_ROUTE_PATH.d.ts

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

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

@@ -1,6 +0,0 @@
-/**
- * One minute in ms
- * @author Gabe Abrams
- */
-declare const MINUTE_IN_MS = 60000;
-export default MINUTE_IN_MS;

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

@@ -1,6 +0,0 @@
-/**
- * Path that all routes start with
- * @author Gabe Abrams
- */
-declare const ROUTE_PATH_PREFIX = "/dce-reactkit";
-export default ROUTE_PATH_PREFIX;

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

@@ -1,6 +0,0 @@
-/**
- * Route for checking if the current user is a select admin
- * @author Gabe Abrams
- */
-declare const SELECT_ADMIN_CHECK_ROUTE = "/api/admin/select/is-select-admin";
-export default SELECT_ADMIN_CHECK_ROUTE;

package/dist/esm/types/errors/ErrorWithCode.d.ts

@@ -1,9 +0,0 @@
-/**
- * An error with a code
- * @author Gabe Abrams
- */
-declare class ErrorWithCode extends Error {
-    code: string;
-    constructor(message: string, code: string);
-}
-export default ErrorWithCode;

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

@@ -1,10 +0,0 @@
-/**
- * Shorten text so it fits into a certain number of chars
- * @author Gabe Abrams
- * @param text the text to abbreviate
- * @param maxChars the maximum number of chars to include
- * @returns abbreviated text with length no greater than maxChars
- *   (including ellipses if applicable)
- */
-declare const abbreviate: (text: string, maxChars: number) => string;
-export default abbreviate;

package/dist/esm/types/helpers/abbreviate.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for abbreviate helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/asyncArrayFunctions/everyAsync.d.ts

@@ -1,13 +0,0 @@
-/**
- * Run the operator function on each item in the array, returning true if
- *   the operator function returns true for every item in the array
- * @author Gabe Abrams
- * @param operatorFunction the operator function to apply. If it returns true
- *   for every item, this function will return true
- * @returns true if the operator function returns true for every item in the array
- */
-declare const everyAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
-    breakNow: () => void;
-    array: T[];
-}) => Promise<any>) => Promise<boolean>;
-export default everyAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/everyAsync.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/asyncArrayFunctions/filterAsync.d.ts

@@ -1,13 +0,0 @@
-/**
- * Run the operator function on each item in the array, returning a new array
- *   that only contains the items that pass the filter
- * @author Gabe Abrams
- * @param operatorFunction the operator function to apply. If it returns true
- *   for an item, the item will be included in the returned array
- * @returns the filtered array
- */
-declare const filterAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
-    breakNow: () => void;
-    array: T[];
-}) => Promise<any>) => Promise<T[]>;
-export default filterAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/filterAsync.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/asyncArrayFunctions/forEachAsync.d.ts

@@ -1,10 +0,0 @@
-/**
- * Run the operator function on each item in the array
- * @author Gabe Abrams
- * @param operatorFunction the operator function to apply
- */
-declare const forEachAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
-    breakNow: () => void;
-    array: T[];
-}) => void) => Promise<void>;
-export default forEachAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/forEachAsync.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/asyncArrayFunctions/mapAsync.d.ts

@@ -1,11 +0,0 @@
-/**
- * Run the operator function on each item in the array, collecting all results
- * @author Gabe Abrams
- * @param operatorFunction the operator function to apply
- * @returns the array of results
- */
-declare const mapAsync: <T, U>(array: T[], operatorFunction: (item: T, index: number, opts: {
-    breakNow: () => void;
-    array: T[];
-}) => Promise<U>) => Promise<U[]>;
-export default mapAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/mapAsync.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/asyncArrayFunctions/someAsync.d.ts

@@ -1,13 +0,0 @@
-/**
- * Run the operator function on each item in the array, returning true if
- *   the operator function returns true for any item in the array
- * @author Gabe Abrams
- * @param operatorFunction the operator function to apply. If it returns true
- *   for any item, this function will return true
- * @returns true if the operator function returns true for any item in the array
- */
-declare const someAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
-    breakNow: () => void;
-    array: T[];
-}) => Promise<any>) => Promise<boolean>;
-export default someAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/someAsync.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,8 +0,0 @@
-/**
- * Get the average of a set of numbers
- * @author Gabe Abrams
- * @param nums the numbers to average
- * @returns average value or 0 if no numbers
- */
-declare const avg: (nums: number[]) => number;
-export default avg;

package/dist/esm/types/helpers/avg.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Unit tests for avg helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,7 +0,0 @@
-/**
- * Capitalize every word in a string (just the first letter)
- * @param str string to capitalize
- * @returns string with every word capitalized
- */
-declare const capitalize: (str: string) => string;
-export default capitalize;

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

@@ -1,9 +0,0 @@
-/**
- * Round a number (ceiling) to a certain number of decimals
- * @author Gabe Abrams
- * @param num the number to round
- * @param numDecimals the number of decimals to round to
- * @returns rounded number
- */
-declare const ceilToNumDecimals: (num: number, numDecimals: number) => number;
-export default ceilToNumDecimals;

package/dist/esm/types/helpers/ceilToNumDecimals.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the ceilToNumDecimals helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,8 +0,0 @@
-/**
- * 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/helpers/compareArraysByProp.d.ts

@@ -1,13 +0,0 @@
-/**
- * Compare two arrays of objects by only comparing the values in a specific
- *  property (e.g. compare user arrays by comparing their user.id values)
- * @author Gabe Abrams
- * @param a the first array
- * @param b the second array
- * @param prop the property to compare with, or an array of props to compare
- *   with (if array, all values associated with those props must match)
- * @returns true if the arrays contain the same objects as determined by
- *   the values associated with each object's prop
- */
-declare const compareArraysByProp: (a: any[], b: any[], prop: string | string[]) => boolean;
-export default compareArraysByProp;

package/dist/esm/types/helpers/compareArraysByProp.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the compareArraysByProp helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,12 +0,0 @@
-/**
- * For every element in an array, extract the value of a prop
- *   (e.g. for all user objects, extract their ages and put that into a new
- *   ages array)
- * @author Gabe Abrams
- * @param arr the array of objects to operate on
- * @param prop the property to extract from each object
- * @returns new array containing the corresponding values, in order, of each
- *   object in the original array
- */
-declare const extractProp: (arr: any[], prop: string) => any[];
-export default extractProp;

package/dist/esm/types/helpers/extractProp.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the extractProp helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,9 +0,0 @@
-/**
- * Round a number (floor) to a certain number of decimals
- * @author Gabe Abrams
- * @param num the number to round
- * @param numDecimals the number of decimals to round to
- * @returns rounded number
- */
-declare const floorToNumDecimals: (num: number, numDecimals: number) => number;
-export default floorToNumDecimals;

package/dist/esm/types/helpers/floorToNumDecimals.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the floorToNumDecimals helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,10 +0,0 @@
-/**
- * Force a number to stay within specific bounds
- * @author Gabe Abrams
- * @param num the number to move into the bounds
- * @param min the minimum number in the bound
- * @param max the maximum number in the bound
- * @returns bounded number
- */
-declare const forceNumIntoBounds: (num: number, min: number, max: number) => number;
-export default forceNumIntoBounds;

package/dist/esm/types/helpers/forceNumIntoBounds.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the forceNumIntoBounds helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,18 +0,0 @@
-/**
- * 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 where each column is an object with:
- * - title: the column title
- * - param: the key in the data object to use for this column
- * - textIfUndefined: optional text to use if the value is undefined (defaults to empty string)
- * @returns multiline csv string
- */
-declare const genCSV: (data: {
-    [k: string]: any;
-}[], columns: {
-    title: string;
-    param: string;
-    textIfUndefined?: string;
-}[]) => string;
-export default genCSV;

package/dist/esm/types/helpers/genCSV.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the genCSV helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,12 +0,0 @@
-/**
- * Given an array of strings, create a single comma-separated string that includes
- * 'and' as well as an oxford comma.
- *   Ex: ['apples'] => 'apples'
- *   Ex: ['apples', 'bananas'] => 'apples and bananas'
- *   Ex: ['apples', 'bananas', 'grapes'] => 'apples, bananas, and grapes'
- * @author Austen Money
- * @param list an array of elements to be made into a single comma-separated string.
- * @returns a comma-separated string.
- */
-declare const genCommaList: (list: string[]) => string;
-export default genCommaList;

package/dist/esm/types/helpers/genCommaList.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,8 +0,0 @@
-/**
- * Get a human-readable description of a date (all in ET)
- * @author Gabe Abrams
- * @param [dateOrTimestamp=today] the date or timestamp for the date to describe
- * @returns human-readable description of the date
- */
-declare const getHumanReadableDate: (dateOrTimestamp?: Date | number) => string;
-export default getHumanReadableDate;

package/dist/esm/types/helpers/getHumanReadableDate.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getHumanReadableDate helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,19 +0,0 @@
-/**
- * Get current time info in local time
- * @author Gabe Abrams
- * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
- * @returns object with timestamp (ms since epoch) and numbers
- *   corresponding to time values for year, month, day, hour, hour12, minute, isPM
- *   where hour is in 24hr time and hour12 is in 12hr time.
- */
-declare const getLocalTimeInfo: (dateOrTimestamp?: Date | number) => {
-    timestamp: number;
-    year: number;
-    month: number;
-    day: number;
-    hour: number;
-    hour12: number;
-    minute: number;
-    isPM: boolean;
-};
-export default getLocalTimeInfo;

package/dist/esm/types/helpers/getLocalTimeInfo.test.d.ts

@@ -1,6 +0,0 @@
-/**
- * Test for getLocalTimeInfo helper function
- *   NOTE: only works if this test is run on a machine in ET
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,14 +0,0 @@
-/**
- * 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/helpers/getMonthName.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test for getMonthName helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,8 +0,0 @@
-/**
- * Get a number's ordinal
- * @author Gabe Abrams
- * @param num the number being analyzed
- * @returns ordinal
- */
-declare const getOrdinal: (num: number) => string;
-export default getOrdinal;

package/dist/esm/types/helpers/getOrdinal.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getOrdinal helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,7 +0,0 @@
-/**
- * Get the current part of day (morning, evening, etc.)
- * @author Gabe Abrams
- * @returns the part of day (morning, evening, etc.)
- */
-declare const getPartOfDay: () => string;
-export default getPartOfDay;

package/dist/esm/types/helpers/getPartOfDay.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getPartOfDay helper
- * @author Gabe Abrams
- */
-export {};

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

@@ -1,21 +0,0 @@
-/**
- * Get current time info in US Boston Eastern Time, independent of machine
- *   timezone
- * @author Gabe Abrams
- * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
- * @returns object with timestamp (ms since epoch) and numbers
- *   corresponding to ET time values for year, month, day, hour, hour12, minute, second, isPM
- *   where hour is in 24hr time and hour12 is in 12hr time.
- */
-declare const getTimeInfoInET: (dateOrTimestamp?: Date | number) => {
-    timestamp: number;
-    year: number;
-    month: number;
-    day: number;
-    hour: number;
-    hour12: number;
-    minute: number;
-    second: number;
-    isPM: boolean;
-};
-export default getTimeInfoInET;