dce-reactkit 3.5.1-beta.1 → 3.5.3

package/dist/cjs/types/client/initClient.d.ts

@@ -2,7 +2,7 @@
  * Type of CACCL's send request function
  * @author Gabe Abrams
  */
-declare type SendRequestFunction = (opts: {
+type SendRequestFunction = (opts: {
     path: string;
     method: ('GET' | 'POST' | 'DELETE' | 'PUT');
     params?: {

package/dist/cjs/types/components/AppWrapper.d.ts

@@ -5,7 +5,7 @@
  */
 import React from 'react';
 import Variant from '../types/Variant';
-declare type Props = {
+type Props = {
     children: React.ReactNode;
     dark?: boolean;
 };
@@ -32,11 +32,11 @@ export declare const alert: (title: string, text: string) => Promise<undefined>;
  * @returns true if the user confirmed
  */
 export declare const confirm: (title: string, text: string, opts?: {
-    confirmButtonText?: string | undefined;
-    confirmButtonVariant?: Variant | undefined;
-    cancelButtonText?: string | undefined;
-    cancelButtonVariant?: Variant | undefined;
-} | undefined) => Promise<boolean>;
+    confirmButtonText?: string;
+    confirmButtonVariant?: Variant;
+    cancelButtonText?: string;
+    cancelButtonVariant?: Variant;
+}) => Promise<boolean>;
 /**
  * Show a fatal error message
  * @author Gabe Abrams

package/dist/cjs/types/components/ButtonInputGroup.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     label: string;
     minLabelWidth?: string;
     children: React.ReactNode;

package/dist/cjs/types/components/CSVDownloadButton.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     filename: string;
     csv: string;
     id?: string;

package/dist/cjs/types/components/CheckboxButton.d.ts

@@ -4,7 +4,7 @@
  */
 import React from 'react';
 import Variant from '../types/Variant';
-declare type Props = {
+type Props = {
     text: string;
     onChanged: (checked: boolean) => void;
     ariaLabel: string;

package/dist/cjs/types/components/CopiableBox.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     text: string;
     maxTextWidthRem?: number;
     label?: string;

package/dist/cjs/types/components/DBEntryManagerPanel/AddOrEditDBEntry/CreatableMultiselect.d.ts

@@ -1,6 +1,12 @@
+/**
+ * Multiselect component that allows the user to type in values and add them to
+ *   the multiselect component
+ * @author Yuen Ler Chow
+ * @author Gabe Abrams
+ */
 import React from 'react';
 import DBEntryFieldType from '../types/DBEntryFieldType';
-declare type Props = {
+type Props = {
     type: DBEntryFieldType.StringArray | DBEntryFieldType.NumberArray;
     values: string[] | number[];
     onChange: (values: string[] | number[]) => void;

package/dist/cjs/types/components/DBEntryManagerPanel/AddOrEditDBEntry/index.d.ts

@@ -1,11 +1,12 @@
 /**
  * Panel for adding a DBEntry to the database
  * @author Yuen Ler Chow
+ * @author Gabe Abrams
  */
 import React from 'react';
 import DBEntry from '../types/DBEntry';
 import DBEntryField from '../types/DBEntryField';
-declare type Props = {
+type Props = {
     /**
      * Handler for when the user finishes adding the DBEntry
      * (if no DBEntry is returned, process was cancelled)
@@ -14,15 +15,15 @@ declare type Props = {
     onFinished: (dbEntry?: DBEntry) => void;
     /**
      * Function to validate the DBEntry before saving
-     * @param dbEntry
+     * @param dbEntry the DBEntry to validate
      */
     validateEntry?: (dbEntry: DBEntry) => Promise<void>;
     /**
      * Function to modify the DBEntry before saving
-     * @param dbEntry
+     * @param dbEntry the DBEntry to modify
      * @returns the modified DBEntry
      */
-    modifyEntry?: (dbEntry: DBEntry) => DBEntry;
+    modifyEntry?: (dbEntry: DBEntry) => Promise<DBEntry> | DBEntry;
     entryFields: DBEntryField[];
     dbEntryToEdit?: DBEntry;
     idPropName: string;

package/dist/cjs/types/components/DBEntryManagerPanel/helpers/generateEndpointPath.d.ts

@@ -5,5 +5,5 @@
  * @param [adminsOnly] true if the endpoint is for admins only
  * @returns the endpoint path
  */
-declare const generateEndpointPath: (collectionName: string, adminsOnly?: boolean | undefined) => string;
+declare const generateEndpointPath: (collectionName: string, adminsOnly?: boolean) => string;
 export default generateEndpointPath;

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

@@ -1,19 +1,30 @@
 /**
  * DB Entry Manager Panel
  * @author Yuen Ler Chow
+ * @author Gabe Abrams
  */
 import React from 'react';
 import DBEntry from './types/DBEntry';
 import DBEntryField from './types/DBEntryField';
-declare type Props = {
+type Props = {
     entryFields: DBEntryField[];
     idPropName: string;
     titlePropName: string;
     descriptionPropName: string;
     itemListTitle: string;
     itemName: string;
+    /**
+     * Function to validate the db entry before sending to the server
+     *   (throws an error if not validate)
+     * @param dbEntry the db entry to validate
+     */
     validateEntry?: (dbEntry: DBEntry) => Promise<void>;
-    modifyEntry?: (dbEntry: DBEntry) => Promise<DBEntry>;
+    /**
+     * Function to modify the db entry before sending to the server
+     * @param dbEntry the db entry to modify
+     * @returns the modified db entry
+     */
+    modifyEntry?: (dbEntry: DBEntry) => Promise<DBEntry> | DBEntry;
     disableEdit?: boolean;
     collectionName: string;
     adminsOnly?: boolean;

package/dist/cjs/types/components/DBEntryManagerPanel/types/DBEntry.d.ts

@@ -2,7 +2,7 @@
  * Generic type for an object
  * @author Yuen Ler Chow
  */
-declare type DBEntry = {
+type DBEntry = {
     [k: string]: any;
 };
 export default DBEntry;

package/dist/cjs/types/components/DBEntryManagerPanel/types/DBEntryField.d.ts

@@ -3,7 +3,7 @@ import DBEntryFieldType from './DBEntryFieldType';
  * A database entry input field
  * @author Yuen Ler Chow
  */
-declare type DBEntryField = ({
+type DBEntryField = ({
     label: string;
     objectKey: string;
     placeholder: string;

package/dist/cjs/types/components/Drawer.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     customBackgroundColor?: string;
     children: React.ReactNode;
 };

package/dist/cjs/types/components/ErrorBox.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     error: any;
     title?: string;
     onClose?: () => void;

package/dist/cjs/types/components/IntelliTable.d.ts

@@ -4,7 +4,7 @@
  */
 import React from 'react';
 import IntelliTableColumn from '../types/IntelliTableColumn';
-declare type Props = {
+type Props = {
     title: string;
     id: string;
     data: {

package/dist/cjs/types/components/ItemPicker/NestableItemList.d.ts

@@ -5,7 +5,7 @@
  */
 import React from 'react';
 import PickableItem from './types/PickableItem';
-declare type Props = {
+type Props = {
     items: PickableItem[];
     /**
      * Handler to call when item selection is changed

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

@@ -4,7 +4,7 @@
  */
 import React from 'react';
 import PickableItem from './types/PickableItem';
-declare type Props = {
+type Props = {
     title: string;
     items: PickableItem[];
     /**

package/dist/cjs/types/components/ItemPicker/types/PickableItem.d.ts

@@ -2,7 +2,7 @@
  * An item that can be chosen (for use within ItemPicker)
  * @author Gabe Abrams
  */
-declare type PickableItem = ({
+type PickableItem = ({
     id: number | string;
     name: string;
     link?: string;

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

@@ -5,7 +5,7 @@
  */
 import React from 'react';
 import LogMetadataType from '../types/LogMetadataType';
-declare type Props = {
+type Props = {
     LogMetadata: LogMetadataType;
     onClose: () => void;
 };

package/dist/cjs/types/components/Modal.d.ts

@@ -7,7 +7,7 @@ import Variant from '../types/Variant';
 import ModalButtonType from '../types/ModalButtonType';
 import ModalSize from '../types/ModalSize';
 import ModalType from '../types/ModalType';
-declare type Props = {
+type Props = {
     type?: ModalType;
     size?: ModalSize;
     title?: React.ReactNode;

package/dist/cjs/types/components/PopFailureMark.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     sizeRem?: number;
     circleVariant?: string;
     xVariant?: string;

package/dist/cjs/types/components/PopPendingMark.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     sizeRem?: number;
     circleVariant?: string;
     hourglassVariant?: string;

package/dist/cjs/types/components/PopSuccessMark.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     sizeRem?: number;
     circleVariant?: string;
     checkVariant?: string;

package/dist/cjs/types/components/RadioButton.d.ts

@@ -4,7 +4,7 @@
  */
 import React from 'react';
 import Variant from '../types/Variant';
-declare type Props = {
+type Props = {
     text: string;
     onSelected: () => void;
     ariaLabel: string;

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

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     ariaLabel: string;
     name: string;
     month: number;

package/dist/cjs/types/components/TabBox.d.ts

@@ -3,7 +3,7 @@
  * @author Gabe Abrams
  */
 import React from 'react';
-declare type Props = {
+type Props = {
     title: React.ReactNode;
     children: React.ReactNode;
     noBottomMargin?: boolean;

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

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

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

@@ -3,7 +3,7 @@ import express from 'express';
  * Interface for a collection in the database
  * @author Yuen Ler Chow
  */
-interface Collection {
+type DCEMangoCollection = {
     /**
      * Find all items in the collection that match the filter query
      * @param filterQuery
@@ -22,7 +22,7 @@ interface Collection {
     delete: (filterQuery: {
         id: string;
     }) => Promise<void>;
-}
+};
 /**
  * Add all routes for the DBEditor
  * @author Yuen Ler Chow
@@ -30,11 +30,12 @@ interface Collection {
  * @param opts.app express app to add routes too
  * @param opts.collectionName the name of the collection
  * @param opts.adminsOnly true if the endpoint is for admins only
+ * @param opts.collection dce-mango db collection
  */
 declare const addDBEditorEndpoints: (opts: {
     app: express.Application;
     collectionName: string;
     adminsOnly: boolean;
-    collection: Collection;
+    collection: DCEMangoCollection;
 }) => void;
 export default addDBEditorEndpoints;

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

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

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

@@ -1,3 +1,8 @@
+/**
+ * Reset the cached version of canReview
+ * @author Gabe Abrams
+ */
+export declare const resetCanReviewCache: () => void;
 /**
  * Check if the current user can review logs
  * @author Gabe Abrams

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

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

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

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

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

@@ -4,9 +4,10 @@
  * @author Gabe Abrams
  * @param a the first array
  * @param b the second array
- * @param prop the property to compare with
+ * @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) => boolean;
+declare const compareArraysByProp: (a: any[], b: any[], prop: string | string[]) => boolean;
 export default compareArraysByProp;

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * 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/cjs/types/helpers/genCommaList.test.d.ts

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

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

@@ -33,14 +33,14 @@ declare const genRouteHandler: (opts: {
         req: any;
         next: () => void;
         redirect: (pathOrURL: string) => void;
-        send: (text: string, status?: number | undefined) => void;
+        send: (text: string, status?: number) => void;
         renderErrorPage: (opts?: {
-            title?: string | undefined;
-            description?: string | undefined;
-            code?: string | undefined;
-            pageTitle?: string | undefined;
-            status?: number | undefined;
-        } | undefined) => void;
+            title?: string;
+            description?: string;
+            code?: string;
+            pageTitle?: string;
+            status?: number;
+        }) => void;
         logServerEvent: LogFunction;
     }) => any;
     skipSessionCheck?: boolean | undefined;

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

@@ -4,5 +4,5 @@
  * @param [dateOrTimestamp=today] the date or timestamp for the date to describe
  * @returns human-readable description of the date
  */
-declare const getHumanReadableDate: (dateOrTimestamp?: number | Date | undefined) => string;
+declare const getHumanReadableDate: (dateOrTimestamp?: Date | number) => string;
 export default getHumanReadableDate;

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

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

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

@@ -6,7 +6,7 @@
  *   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?: number | Date | undefined) => {
+declare const getLocalTimeInfo: (dateOrTimestamp?: Date | number) => {
     timestamp: number;
     year: number;
     month: number;

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

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

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

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

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

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

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

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

@@ -7,7 +7,7 @@
  *   corresponding to ET time values for year, month, day, hour, hour12, minute, isPM
  *   where hour is in 24hr time and hour12 is in 12hr time.
  */
-declare const getTimeInfoInET: (dateOrTimestamp?: number | Date | undefined) => {
+declare const getTimeInfoInET: (dateOrTimestamp?: Date | number) => {
     timestamp: number;
     year: number;
     month: number;

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

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

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

@@ -8,5 +8,5 @@
  *   once
  * @returns array of resolved values in the same order as the task functions
  */
-declare const parallelLimit: (taskFunctions: (() => Promise<any>)[], limit?: number | undefined) => Promise<any[]>;
+declare const parallelLimit: (taskFunctions: (() => Promise<any>)[], limit?: number) => Promise<any[]>;
 export default parallelLimit;

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,19 @@
+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

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

@@ -0,0 +1,11 @@
+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

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

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

@@ -0,0 +1,11 @@
+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;