dce-reactkit 3.5.1-beta.1 → 3.5.2

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

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

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

@@ -0,0 +1,22 @@
+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/esm/types/helpers/validators/validateString.test.d.ts

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

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

@@ -57,6 +57,10 @@ import extractProp from './helpers/extractProp';
 import compareArraysByProp from './helpers/compareArraysByProp';
 import getLocalTimeInfo from './helpers/getLocalTimeInfo';
 import addDBEditorEndpoints from './helpers/addDBEditorEndpoints';
+import genCommaList from './helpers/genCommaList';
+import validateEmail from './helpers/validators/validateEmail';
+import validatePhoneNumber from './helpers/validators/validatePhoneNumber';
+import validateString from './helpers/validators/validateString';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -75,4 +79,4 @@ 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, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, 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, getLocalTimeInfo, initClient, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, 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, initClient, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };

package/dist/esm/types/server/initServer.d.ts

@@ -1,4 +1,4 @@
-declare type GetLaunchInfoFunction = (req: any) => {
+type GetLaunchInfoFunction = (req: any) => {
     launched: boolean;
     launchInfo?: any;
 };

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

@@ -3,7 +3,7 @@ import ParamType from './ParamType';
  * Column description for a column in the IntelliTable
  * @author Gabe Abrams
  */
-declare type IntelliTableColumn = {
+type IntelliTableColumn = {
     title: string;
     param: string;
     type: (ParamType.Boolean | ParamType.Float | ParamType.Int | ParamType.String | ParamType.JSON);

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

@@ -3,7 +3,7 @@ import LogLevel from '../LogLevel';
  * Main information in a log event
  * @author Gabe Abrams
  */
-declare type LogMainInfo = {
+type LogMainInfo = {
     id: string;
     userFirstName: string;
     userLastName: string;

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

@@ -3,7 +3,7 @@ import LogSource from '../LogSource';
  * Log info that is specific to the type of source
  * @author Gabe Abrams
  */
-declare type LogSourceSpecificInfo = ({
+type LogSourceSpecificInfo = ({
     source: LogSource.Client;
 } | {
     source: LogSource.Server;

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

@@ -4,7 +4,7 @@ import LogType from '../LogType';
  * Log info that is specific to the type of log
  * @author Gabe Abrams
  */
-declare type LogTypeSpecificInfo = ({
+type LogTypeSpecificInfo = ({
     type: LogType.Error;
     errorMessage: string;
     errorCode: string;

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

@@ -6,5 +6,5 @@ import LogTypeSpecificInfo from './LogTypeSpecificInfo';
  *   error encountered by a user
  * @author Gabe Abrams
  */
-declare type Log = (LogMainInfo & LogSourceSpecificInfo & LogTypeSpecificInfo);
+type Log = (LogMainInfo & LogSourceSpecificInfo & LogTypeSpecificInfo);
 export default Log;

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

@@ -5,7 +5,7 @@ import LogLevel from './LogLevel';
  * Type of a log action function
  * @author Gabe Abrams
  */
-declare type LogFunction = (opts: ({
+type LogFunction = (opts: ({
     context: string | {
         _: string;
     };

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

@@ -2,7 +2,7 @@
  * Type of the context map in a LogMetadata file
  * @author Gabe Abrams
  */
-declare type LogMetadataContextMap = {
+type LogMetadataContextMap = {
     [k: string]: (string | {
         _: string;
         [k: string]: string;

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

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

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

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

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

@@ -5,7 +5,7 @@ import LogMetadataTargetMap from './LogMetadataTargetMap';
  * Type of a LogMetadata file
  * @author Gabe Abrams
  */
-declare type LogMetadataType = {
+type LogMetadataType = {
     Context?: LogMetadataContextMap;
     Tag?: LogMetadataTagMap;
     Target?: LogMetadataTargetMap;

package/dist/index.d.ts

@@ -23,7 +23,7 @@ declare enum Variant {
  * @author Gabe Abrams
  */
 
-declare type Props$h = {
+type Props$h = {
     children: React.ReactNode;
     dark?: boolean;
 };
@@ -50,11 +50,11 @@ declare const alert: (title: string, text: string) => Promise<undefined>;
  * @returns true if the user confirmed
  */
 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
@@ -75,7 +75,7 @@ declare const LoadingSpinner: () => JSX.Element;
  * @author Gabe Abrams
  */
 
-declare type Props$g = {
+type Props$g = {
     error: any;
     title?: string;
     onClose?: () => void;
@@ -131,7 +131,7 @@ declare enum ModalType {
  * @author Gabe Abrams
  */
 
-declare type Props$f = {
+type Props$f = {
     type?: ModalType;
     size?: ModalSize;
     title?: React.ReactNode;
@@ -167,7 +167,7 @@ declare const Modal: React.FC<Props$f>;
  * @author Gabe Abrams
  */
 
-declare type Props$e = {
+type Props$e = {
     title: React.ReactNode;
     children: React.ReactNode;
     noBottomMargin?: boolean;
@@ -180,7 +180,7 @@ declare const TabBox: React.FC<Props$e>;
  * @author Gabe Abrams
  */
 
-declare type Props$d = {
+type Props$d = {
     text: string;
     onSelected: () => void;
     ariaLabel: string;
@@ -199,7 +199,7 @@ declare const RadioButton: React.FC<Props$d>;
  * @author Gabe Abrams
  */
 
-declare type Props$c = {
+type Props$c = {
     text: string;
     onChanged: (checked: boolean) => void;
     ariaLabel: string;
@@ -220,7 +220,7 @@ declare const CheckboxButton: React.FC<Props$c>;
  * @author Gabe Abrams
  */
 
-declare type Props$b = {
+type Props$b = {
     label: string;
     minLabelWidth?: string;
     children: React.ReactNode;
@@ -234,7 +234,7 @@ declare const ButtonInputGroup: React.FC<Props$b>;
  * @author Gabe Abrams
  */
 
-declare type Props$a = {
+type Props$a = {
     ariaLabel: string;
     name: string;
     month: number;
@@ -257,7 +257,7 @@ declare const SimpleDateChooser: React.FC<Props$a>;
  * @author Gabe Abrams
  */
 
-declare type Props$9 = {
+type Props$9 = {
     customBackgroundColor?: string;
     children: React.ReactNode;
 };
@@ -268,7 +268,7 @@ declare const Drawer: React.FC<Props$9>;
  * @author Gabe Abrams
  */
 
-declare type Props$8 = {
+type Props$8 = {
     sizeRem?: number;
     circleVariant?: string;
     checkVariant?: string;
@@ -280,7 +280,7 @@ declare const PopSuccessMark: React.FC<Props$8>;
  * @author Gabe Abrams
  */
 
-declare type Props$7 = {
+type Props$7 = {
     sizeRem?: number;
     circleVariant?: string;
     xVariant?: string;
@@ -292,7 +292,7 @@ declare const PopFailureMark: React.FC<Props$7>;
  * @author Gabe Abrams
  */
 
-declare type Props$6 = {
+type Props$6 = {
     sizeRem?: number;
     circleVariant?: string;
     hourglassVariant?: string;
@@ -304,7 +304,7 @@ declare const PopPendingMark: React.FC<Props$6>;
  * @author Gabe Abrams
  */
 
-declare type Props$5 = {
+type Props$5 = {
     text: string;
     maxTextWidthRem?: number;
     label?: string;
@@ -322,7 +322,7 @@ declare const CopiableBox: React.FC<Props$5>;
  * 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;
@@ -339,7 +339,7 @@ declare type PickableItem = ({
  * @author Yuen Ler Chow
  */
 
-declare type Props$4 = {
+type Props$4 = {
     title: string;
     items: PickableItem[];
     /**
@@ -356,7 +356,7 @@ declare const ItemPicker: React.FC<Props$4>;
  * Type of the context map in a LogMetadata file
  * @author Gabe Abrams
  */
-declare type LogMetadataContextMap = {
+type LogMetadataContextMap = {
     [k: string]: (string | {
         _: string;
         [k: string]: string;
@@ -367,7 +367,7 @@ declare type LogMetadataContextMap = {
  * Type of the tag map inside a LogMetadata file
  * @author Gabe Abrams
  */
-declare type LogMetadataTagMap = {
+type LogMetadataTagMap = {
     [k: string]: string;
 };
 
@@ -375,7 +375,7 @@ declare type LogMetadataTagMap = {
  * Type of the target map inside a LogMetadata file
  * @author Gabe Abrams
  */
-declare type LogMetadataTargetMap = {
+type LogMetadataTargetMap = {
     [k: string]: string;
 };
 
@@ -383,7 +383,7 @@ declare type LogMetadataTargetMap = {
  * Type of a LogMetadata file
  * @author Gabe Abrams
  */
-declare type LogMetadataType = {
+type LogMetadataType = {
     Context?: LogMetadataContextMap;
     Tag?: LogMetadataTagMap;
     Target?: LogMetadataTargetMap;
@@ -395,7 +395,7 @@ declare type LogMetadataType = {
  * @author Gabe Abrams
  */
 
-declare type Props$3 = {
+type Props$3 = {
     LogMetadata: LogMetadataType;
     onClose: () => void;
 };
@@ -422,7 +422,7 @@ declare enum ParamType {
  * Column description for a column in the IntelliTable
  * @author Gabe Abrams
  */
-declare type IntelliTableColumn = {
+type IntelliTableColumn = {
     title: string;
     param: string;
     type: (ParamType.Boolean | ParamType.Float | ParamType.Int | ParamType.String | ParamType.JSON);
@@ -434,7 +434,7 @@ declare type IntelliTableColumn = {
  * @author Gabe Abrams
  */
 
-declare type Props$2 = {
+type Props$2 = {
     title: string;
     id: string;
     data: {
@@ -451,7 +451,7 @@ declare const IntelliTable: React.FC<Props$2>;
  * @author Gabe Abrams
  */
 
-declare type Props$1 = {
+type Props$1 = {
     filename: string;
     csv: string;
     id?: string;
@@ -469,7 +469,7 @@ declare const CSVDownloadButton: React.FC<Props$1>;
  * Generic type for an object
  * @author Yuen Ler Chow
  */
-declare type DBEntry = {
+type DBEntry = {
     [k: string]: any;
 };
 
@@ -489,7 +489,7 @@ declare enum DBEntryFieldType {
  * A database entry input field
  * @author Yuen Ler Chow
  */
-declare type DBEntryField = ({
+type DBEntryField = ({
     label: string;
     objectKey: string;
     placeholder: string;
@@ -536,17 +536,28 @@ declare type DBEntryField = ({
 /**
  * DB Entry Manager Panel
  * @author Yuen Ler Chow
+ * @author Gabe Abrams
  */
 
-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;
@@ -600,7 +611,7 @@ declare const DynamicWord: {
  * 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?: {
@@ -749,7 +760,7 @@ declare enum LogLevel {
  * Main information in a log event
  * @author Gabe Abrams
  */
-declare type LogMainInfo = {
+type LogMainInfo = {
     id: string;
     userFirstName: string;
     userLastName: string;
@@ -796,7 +807,7 @@ declare enum LogSource {
  * Log info that is specific to the type of source
  * @author Gabe Abrams
  */
-declare type LogSourceSpecificInfo = ({
+type LogSourceSpecificInfo = ({
     source: LogSource.Client;
 } | {
     source: LogSource.Server;
@@ -840,7 +851,7 @@ declare enum LogType {
  * Log info that is specific to the type of log
  * @author Gabe Abrams
  */
-declare type LogTypeSpecificInfo = ({
+type LogTypeSpecificInfo = ({
     type: LogType.Error;
     errorMessage: string;
     errorCode: string;
@@ -856,13 +867,13 @@ declare type LogTypeSpecificInfo = ({
  *   error encountered by a user
  * @author Gabe Abrams
  */
-declare type Log = (LogMainInfo & LogSourceSpecificInfo & LogTypeSpecificInfo);
+type Log = (LogMainInfo & LogSourceSpecificInfo & LogTypeSpecificInfo);
 
 /**
  * Type of a log action function
  * @author Gabe Abrams
  */
-declare type LogFunction = (opts: ({
+type LogFunction = (opts: ({
     context: string | {
         _: string;
     };
@@ -912,14 +923,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;
@@ -951,7 +962,7 @@ declare const handleError: (res: any, error: ({
  */
 declare const handleSuccess: (res: any, body: any) => undefined;
 
-declare type GetLaunchInfoFunction = (req: any) => {
+type GetLaunchInfoFunction = (req: any) => {
     launched: boolean;
     launchInfo?: any;
 };
@@ -996,7 +1007,7 @@ declare const getOrdinal: (num: number) => string;
  *   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;
@@ -1040,7 +1051,7 @@ declare const startMinWait: (minWaitMs: number) => () => Promise<void>;
  * @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;
 
 /**
  * Get the current part of day (morning, evening, etc.)
@@ -1076,7 +1087,7 @@ declare const onlyKeepLetters: (str: string) => string;
  *   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[]>;
 
 /**
  * Log a user action on the client (cannot be used on the server)
@@ -1152,11 +1163,12 @@ declare const extractProp: (arr: any[], prop: string) => any[];
  * @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;
 
 /**
  * Get current time info in local time
@@ -1166,7 +1178,7 @@ declare const compareArraysByProp: (a: any[], b: any[], prop: string) => boolean
  *   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;
@@ -1181,7 +1193,7 @@ declare const getLocalTimeInfo: (dateOrTimestamp?: number | Date | undefined) =>
  * 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
@@ -1200,7 +1212,7 @@ interface Collection {
     delete: (filterQuery: {
         id: string;
     }) => Promise<void>;
-}
+};
 /**
  * Add all routes for the DBEditor
  * @author Yuen Ler Chow
@@ -1208,14 +1220,80 @@ 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;
 
+/**
+ * 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;
+
+/**
+ * Result of a validation function.
+ * @author Austen Money
+ */
+type ValidationResult<CleanedValueType> = ({
+    isValid: true;
+    cleanedValue: CleanedValueType;
+} | {
+    isValid: false;
+    errorMessage: string;
+});
+
+/**
+ * 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>;
+
+/**
+ * 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>;
+
+/**
+ * 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>;
+
 /**
  * List of error codes built into the react kit
  * @author Gabe Abrams
@@ -1266,4 +1344,4 @@ declare const LogBuiltInMetadata: {
     };
 };
 
-export { AppWrapper, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, DynamicWord, 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, addDBEditorEndpoints, alert, avg, canReviewLogs, ceilToNumDecimals, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initClient, initLogCollection, initServer, isMobileOrTablet, logClientEvent, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, visitServerEndpoint, waitMs };
+export { AppWrapper, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, DynamicWord, 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, addDBEditorEndpoints, alert, avg, canReviewLogs, ceilToNumDecimals, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initClient, initLogCollection, initServer, isMobileOrTablet, logClientEvent, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };