dce-reactkit 4.3.4 → 5.0.0

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

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

package/dist/cjs/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/cjs/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/cjs/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/cjs/types/helpers/getMonthName.test.d.ts

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

package/dist/cjs/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/cjs/types/helpers/getOrdinal.test.d.ts

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

package/dist/cjs/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/cjs/types/helpers/getPartOfDay.test.d.ts

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

package/dist/cjs/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;

package/dist/cjs/types/helpers/getTimeInfoInET.test.d.ts

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

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

@@ -1,20 +0,0 @@
-/**
- * Get a timestamp (ms since epoch) from time info (year, month, day, hour, minute, etc.) in Eastern Time (ET)
- * @author Gardenia Liu
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.year Year (e.g. 2023)
- * @param opts.month Month (1-12)
- * @param opts.day Day of the month (1-31)
- * @param opts.hour Hour (0-23)
- * @param opts.minute Minute (0-59)
- * @returns Timestamp in milliseconds since epoch
- */
-declare const getTimestampFromTimeInfoInET: (opts: {
-    year: number;
-    month: number;
-    day: number;
-    hour: number;
-    minute: number;
-}) => number;
-export default getTimestampFromTimeInfoInET;

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

@@ -1,10 +0,0 @@
-/**
- * Get number of words in string
- * @author Gardenia Liu
- * @author Allison Zhang
- * @author Gabe Abrams
- * @param text the string to check
- * @returns number of words in the string
- */
-declare const getWordCount: (text: string) => number;
-export default getWordCount;

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

@@ -1,9 +0,0 @@
-/**
- * Convert a string to hyphenated lowercase format with no space or
- *   non-alphanumeric characters
- * @author Gabe Abrams
- * @param str the string to convert
- * @returns the idified string
- */
-declare const idify: (str: string) => string;
-export default idify;

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

@@ -1,8 +0,0 @@
-/**
- * Given a string, only keep the letters inside it
- * @author Gabe Abrams
- * @param str the string to parse
- * @returns only the letters inside of the string
- */
-declare const onlyKeepLetters: (str: string) => string;
-export default onlyKeepLetters;

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

@@ -1,10 +0,0 @@
-/**
- * Pad a number's decimal with zeros on the right
- *   (e.g. 5.2 becomes 5.20 with 2 digit padding)
- * @author Gabe Abrams
- * @param num the number to pad
- * @param numDigits the minimum number of digits after the decimal
- * @returns padded number
- */
-declare const padDecimalZeros: (num: number, numDigits: number) => string;
-export default padDecimalZeros;

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

@@ -1,9 +0,0 @@
-/**
- * Pad a number with zeros on the left (e.g. 5 becomes 05 with 2 digit padding)
- * @author Gabe Abrams
- * @param num the number to pad
- * @param numDigits the minimum number of digits before the decimal
- * @returns padded number
- */
-declare const padZerosLeft: (num: number, numDigits: number) => string;
-export default padZerosLeft;

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

@@ -1,12 +0,0 @@
-/**
- * Run tasks in parallel with a limit on how many tasks can execute at once.
- *   No guarantees are made about the order of task execution
- * @author Gabe Abrams
- * @param taskFunctions functions that start asynchronous tasks and optionally
- *   resolve with values
- * @param [limit=no limit] maximum number of asynchronous tasks to permit to run at
- *   once
- * @returns array of resolved values in the same order as the task functions
- */
-declare const parallelLimit: (taskFunctions: (() => Promise<any>)[], limit?: number) => Promise<any[]>;
-export default parallelLimit;

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

@@ -1,10 +0,0 @@
-/**
- * Prefix a word or name with "a" or "an" depending on whether it starts with a
- *   vowel or not
- * @author Gabe Abrams
- * @param text the text to prefix
- * @param capitalize whether to capitalize the "A" or "An"
- * @returns the text prefixed with "a" or "an"
- */
-declare const prefixWithAOrAn: (text: string, capitalize?: boolean) => string;
-export default prefixWithAOrAn;

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

@@ -1,9 +0,0 @@
-/**
- * Round a number 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 roundToNumDecimals: (num: number, numDecimals: number) => number;
-export default roundToNumDecimals;

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

@@ -1,8 +0,0 @@
-/**
- * Shuffle a given array
- * @author Austen Money
- * @param arr the array to shuffle
- * @returns the shuffled array
- */
-declare const shuffleArray: <T>(arr: T[]) => T[];
-export default shuffleArray;

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

@@ -1,9 +0,0 @@
-/**
- * Start a dynamic wait, call the function once the operation has completed and
- *   the dynamic wait will continue waiting for the rest of the minimum time
- * @author Gabe Abrams
- * @param minWaitMs the minimum number of ms to wait
- * @returns async function to call to finish the wait
- */
-declare const startMinWait: (minWaitMs: number) => () => Promise<void>;
-export default startMinWait;

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

@@ -1,10 +0,0 @@
-/**
- * Create a human readable list from an array of strings.
- *   For example, ['apple', 'orange'] becomes "apple and orange"
- *   and ['apple', 'orange', 'mango'] becomes "apple, orange, and mango"
- * @author Gabe Abrams
- * @param items list of items in the list
- * @returns human-readable list
- */
-declare const stringsToHumanReadableList: (items: string[]) => string;
-export default stringsToHumanReadableList;

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

@@ -1,8 +0,0 @@
-/**
- * Sum the numbers in an array
- * @author Gabe Abrams
- * @param nums the numbers to sum
- * @returns the sum of the numbers
- */
-declare const sum: (nums: number[]) => number;
-export default sum;

package/dist/cjs/types/helpers/validators/ChicagoTitleCase.d.ts

@@ -1,9 +0,0 @@
-/**
- * This function converts a string to title case based on Chicago Title Case
- * Style rules.
- * @author Leisha Bhandari
- * @param input: The input string that needs to be converted to Chicago title
- *               case.
- * @returns Input string converted to title case
- */
-declare const chicagoTitleCase: (input: string) => string;

package/dist/cjs/types/helpers/validators/shared/constants/ERROR_MESSAGES.d.ts

@@ -1,10 +0,0 @@
-export declare const INVALID_REGEX_ERROR = "input does not follow the requested format";
-export declare const INVALID_EMAIL_ERROR = "Please provide a valid email address.";
-export declare const INVALID_PHONE_ERROR = "Please provide a valid phone number.";
-export declare const INVALID_STRING_ERRORS: {
-    MIN_LEN: (minLen: number) => string;
-    MAX_LEN: (maxLen: number) => string;
-    LETTERS_ONLY: string;
-    NUMBERS_ONLY: string;
-    MESSAGE_INTRO: string;
-};

package/dist/cjs/types/helpers/validators/shared/helpers/validateRegex.d.ts

@@ -1,19 +0,0 @@
-import ValidationResult from '../types/ValidationResult';
-/**
- * Determines whether a given input string is considered valid based on
- *   the provided regex.
- * @author Austen Money
- * @param opts object containing all args
- * @param opts.input user-provided input to validate
- * @param opts.regex regular expression to check against input
- * @param [opts.regexDescription] description of what regexString is checking
- *   for, used to customize error message
- * @returns the unchanged input if valid, or a customized error message if
- *   invalid
- */
-declare const validateRegex: (opts: {
-    input: string;
-    regex: RegExp;
-    regexDescription?: string;
-}) => ValidationResult<string>;
-export default validateRegex;

package/dist/cjs/types/helpers/validators/shared/types/ValidationResult.d.ts

@@ -1,12 +0,0 @@
-/**
- * Result of a validation function.
- * @author Austen Money
- */
-type ValidationResult<CleanedValueType> = ({
-    isValid: true;
-    cleanedValue: CleanedValueType;
-} | {
-    isValid: false;
-    errorMessage: string;
-});
-export default ValidationResult;

package/dist/cjs/types/helpers/validators/validURL.d.ts

@@ -1,8 +0,0 @@
-/**
- * This function checks if a given input string is a valid URL.
- * @author Leisha Bhandari
- * @param URL: The input string that needs checked as a URL or not.
- * @returns A true boolean value if the input string is a valid URL, and a false
- *          boolean value if the input string is a invalid URL
- */
-declare function isValid(url: string): boolean;

package/dist/cjs/types/helpers/validators/validateEmail.d.ts

@@ -1,11 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given email address is valid.
- * @author Austen Money
- * @param email email address to validate
- * @returns whether email fulfills proper formatting requirements, includes a
- *   cleaned version of the address without leading or trailing
- *   whitespace if valid or an error message if invalid.
- */
-declare const validateEmail: (email: string) => ValidationResult<string>;
-export default validateEmail;

package/dist/cjs/types/helpers/validators/validateEmail.test.d.ts

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

package/dist/cjs/types/helpers/validators/validatePhoneNumber.d.ts

@@ -1,11 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given phone number is valid.
- * @author Austen Money
- * @param phoneNumber phone number to validate
- * @returns whether phone number is considered valid - if valid, also returns
- *   a cleaned version of the number without any formatting. If invalid,
- *   returns an error message.
- */
-declare const validatePhoneNumber: (phoneNumber: string) => ValidationResult<string>;
-export default validatePhoneNumber;

package/dist/cjs/types/helpers/validators/validatePhoneNumber.test.d.ts

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

package/dist/cjs/types/helpers/validators/validateString.d.ts

@@ -1,22 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given input string is considered valid based on
- *   the provided requirements.
- * @author Austen Money
- * @param input input string
- * @param opts options for validation
- * @returns whether input is considered valid according to reqs - if
- *   valid, returns a cleaned version of input; if invalid, returns
- *   a string containing error messages describing which requirements
- *   were not met.
- */
-declare const validateString: (input: string, opts: {
-    ignoreWhitespace?: boolean;
-    minLen?: number;
-    maxLen?: number;
-    lettersOnly?: boolean;
-    numbersOnly?: boolean;
-    regexTest?: RegExp;
-    regexDescription?: string;
-}) => ValidationResult<string>;
-export default validateString;

package/dist/cjs/types/helpers/validators/validateString.test.d.ts

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

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

@@ -1,7 +0,0 @@
-/**
- * Wait for a certain number of ms
- * @author Gabe Abrams
- * @param ms number of ms to wait
- */
-declare const waitMs: (ms?: number) => Promise<unknown>;
-export default waitMs;

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

@@ -1,14 +0,0 @@
-/**
- * Days of the week
- * @author Gabe Abrams
- */
-declare enum DayOfWeek {
-    Monday = "m",
-    Tuesday = "t",
-    Wednesday = "w",
-    Thursday = "r",
-    Friday = "f",
-    Saturday = "s",
-    Sunday = "u"
-}
-export default DayOfWeek;

package/dist/cjs/types/types/Log/LogMainInfo.d.ts

@@ -1,39 +0,0 @@
-import LogLevel from '../LogLevel';
-/**
- * Main information in a log event
- * @author Gabe Abrams
- */
-type LogMainInfo = {
-    id: string;
-    userFirstName: string;
-    userLastName: string;
-    userEmail: string;
-    userId: number;
-    isLearner: boolean;
-    isAdmin: boolean;
-    isTTM: boolean;
-    courseId: number;
-    courseName: string;
-    browser: {
-        name: string;
-        version: string;
-    };
-    device: {
-        os: string;
-        isMobile: boolean;
-    };
-    year: number;
-    month: number;
-    day: number;
-    hour: number;
-    minute: number;
-    timestamp: number;
-    context: string;
-    subcontext: string;
-    tags: string[];
-    level: LogLevel;
-    metadata?: {
-        [k: string]: any;
-    };
-};
-export default LogMainInfo;

package/dist/cjs/types/types/Log/LogSourceSpecificInfo.d.ts

@@ -1,13 +0,0 @@
-import LogSource from '../LogSource';
-/**
- * Log info that is specific to the type of source
- * @author Gabe Abrams
- */
-type LogSourceSpecificInfo = ({
-    source: LogSource.Client;
-} | {
-    source: LogSource.Server;
-    routePath: string;
-    routeTemplate: string;
-});
-export default LogSourceSpecificInfo;

package/dist/cjs/types/types/Log/LogTypeSpecificInfo.d.ts

@@ -1,17 +0,0 @@
-import LogAction from '../LogAction';
-import LogType from '../LogType';
-/**
- * Log info that is specific to the type of log
- * @author Gabe Abrams
- */
-type LogTypeSpecificInfo = ({
-    type: LogType.Error;
-    errorMessage: string;
-    errorCode: string;
-    errorStack: string;
-} | {
-    type: LogType.Action;
-    target: string;
-    action: LogAction;
-});
-export default LogTypeSpecificInfo;

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

@@ -1,10 +0,0 @@
-import LogMainInfo from './LogMainInfo';
-import LogSourceSpecificInfo from './LogSourceSpecificInfo';
-import LogTypeSpecificInfo from './LogTypeSpecificInfo';
-/**
- * A single log event corresponding to an action performed by a user or an
- *   error encountered by a user
- * @author Gabe Abrams
- */
-type Log = (LogMainInfo & LogSourceSpecificInfo & LogTypeSpecificInfo);
-export default Log;

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

@@ -1,29 +0,0 @@
-/**
- * Types of actions
- * @author Gabe Abrams
- */
-declare enum LogAction {
-    Open = "Open",
-    Close = "Close",
-    Cancel = "Cancel",
-    Expand = "Expand",
-    Collapse = "Collapse",
-    View = "View",
-    Interrupt = "Interrupt",
-    Create = "Create",
-    Modify = "Modify",
-    Delete = "Delete",
-    Add = "Add",
-    Remove = "Remove",
-    Activate = "Activate",
-    Deactivate = "Deactivate",
-    Peek = "Peek",
-    Halt = "Halt",
-    Resume = "Resume",
-    Jump = "Jump",
-    Post = "Post",
-    Like = "Like",
-    Dislike = "Dislike",
-    Unknown = "Unknown"
-}
-export default LogAction;

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

@@ -1,16 +0,0 @@
-/**
- * Built-in metadata for logs
- * @author Gabe Abrams
- */
-declare const LogBuiltInMetadata: {
-    Context: {
-        Uncategorized: string;
-        ServerRenderedErrorPage: string;
-        ServerEndpointError: string;
-        ClientFatalError: string;
-    };
-    Target: {
-        NoTarget: string;
-    };
-};
-export default LogBuiltInMetadata;

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

@@ -1,24 +0,0 @@
-import Log from './Log';
-import LogAction from './LogAction';
-import LogLevel from './LogLevel';
-/**
- * Type of a log action function
- * @author Gabe Abrams
- */
-type LogFunction = (opts: ({
-    context: string | {
-        _: string;
-    };
-    subcontext?: string;
-    tags?: string[];
-    metadata?: {
-        [k: string]: any;
-    };
-    level?: LogLevel;
-} & ({
-    error: any;
-} | {
-    action: LogAction;
-    target?: string;
-}))) => Promise<Log>;
-export default LogFunction;

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

@@ -1,10 +0,0 @@
-/**
- * Allowed log levels
- * @author Gabe Abrams
- */
-declare enum LogLevel {
-    Warn = "Warn",
-    Info = "Info",
-    Debug = "Debug"
-}
-export default LogLevel;

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

@@ -1,11 +0,0 @@
-/**
- * Type of the context map in a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataContextMap = {
-    [k: string]: (string | {
-        _: string;
-        [k: string]: string;
-    });
-};
-export default LogMetadataContextMap;

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

@@ -1,8 +0,0 @@
-/**
- * Type of the tag map inside a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataTagMap = {
-    [k: string]: string;
-};
-export default LogMetadataTagMap;

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

@@ -1,8 +0,0 @@
-/**
- * Type of the target map inside a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataTargetMap = {
-    [k: string]: string;
-};
-export default LogMetadataTargetMap;

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

@@ -1,13 +0,0 @@
-import LogMetadataContextMap from './LogMetadataContextMap';
-import LogMetadataTagMap from './LogMetadataTagMap';
-import LogMetadataTargetMap from './LogMetadataTargetMap';
-/**
- * Type of a LogMetadata file
- * @author Gabe Abrams
- */
-type LogMetadataType = {
-    Context?: LogMetadataContextMap;
-    Tag?: LogMetadataTagMap;
-    Target?: LogMetadataTargetMap;
-};
-export default LogMetadataType;