dce-reactkit 3.4.0-beta.9 → 3.4.1

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/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.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/getHumanReadableDate.test.d.ts

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

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.test.d.ts

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

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
+ */
+declare 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;

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

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

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

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

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

@@ -16,7 +16,6 @@ import ItemPicker from './components/ItemPicker';
 import LogReviewer from './components/LogReviewer';
 import IntelliTable from './components/IntelliTable';
 import CSVDownloadButton from './components/CSVDownloadButton';
-import DBEntryManagerPanel from './components/DBEntryManagerPanel';
 import ErrorWithCode from './errors/ErrorWithCode';
 import MINUTE_IN_MS from './constants/MINUTE_IN_MS';
 import HOUR_IN_MS from './constants/HOUR_IN_MS';
@@ -55,8 +54,11 @@ import canReviewLogs from './helpers/canReviewLogs';
 import isMobileOrTablet from './helpers/isMobileOrTablet';
 import extractProp from './helpers/extractProp';
 import compareArraysByProp from './helpers/compareArraysByProp';
+import genCommaList from './helpers/genCommaList';
+import validateEmail from './helpers/validators/validateEmail';
+import validatePhoneNumber from './helpers/validators/validatePhoneNumber';
+import validateString from './helpers/validators/validateString';
 import getLocalTimeInfo from './helpers/getLocalTimeInfo';
-import addDBEditorEndpoints from './helpers/addDBEditorEndpoints';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -72,7 +74,4 @@ import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 import LogMetadataType from './types/LogMetadataType';
 import IntelliTableColumn from './types/IntelliTableColumn';
 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, 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, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, ParamType, };