dce-reactkit 3.6.15 → 3.6.17

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

@@ -6,7 +6,7 @@ import express from 'express';
 type DCEMangoCollection = {
     /**
      * Find all items in the collection that match the filter query
-     * @param filterQuery
+     * @param filterQuery query for the filter
      * @returns list of items that match the filter query
      */
     find: (filterQuery: any) => Promise<any[]>;

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

@@ -0,0 +1,9 @@
+/**
+ * Create a function that forces a render of a component. Use this only when
+ *   absolutely necessary
+ * @author Gabe Abrams
+ * @param useReducer the useReducer hook
+ * @returns forceRender function
+ */
+declare const useForceRender: (useReducer: any) => () => void;
+export default useForceRender;

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

@@ -68,6 +68,7 @@ import validateString from './helpers/validators/validateString';
 import idify from './helpers/idify';
 import makeLinksClickable from './helpers/makeLinksClickable';
 import combineClassNames from './helpers/combineClassNames';
+import prefixWithAOrAn from './helpers/prefixWithAOrAn';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -86,4 +87,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, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, 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, idify, makeLinksClickable, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, 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, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, 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, idify, makeLinksClickable, prefixWithAOrAn, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, 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/index.d.ts

@@ -1293,7 +1293,7 @@ declare const getLocalTimeInfo: (dateOrTimestamp?: Date | number) => {
 type DCEMangoCollection = {
     /**
      * Find all items in the collection that match the filter query
-     * @param filterQuery
+     * @param filterQuery query for the filter
      * @returns list of items that match the filter query
      */
     find: (filterQuery: any) => Promise<any[]>;
@@ -1426,6 +1426,16 @@ declare const makeLinksClickable: (text: string, opts?: {
  */
 declare const combineClassNames: (classNames: (string | undefined | null | false)[]) => string;
 
+/**
+ * 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;
+
 /**
  * List of error codes built into the react kit
  * @author Gabe Abrams
@@ -1476,4 +1486,4 @@ declare const LogBuiltInMetadata: {
     };
 };
 
-export { AppWrapper, AutoscrollToBottomContainer, 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, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };
+export { AppWrapper, AutoscrollToBottomContainer, 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, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.6.15",
+  "version": "3.6.17",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/helpers/addDBEditorEndpoints.ts

@@ -15,7 +15,7 @@ import ParamType from '../types/ParamType';
 type DCEMangoCollection = {
   /**
    * Find all items in the collection that match the filter query
-   * @param filterQuery 
+   * @param filterQuery query for the filter
    * @returns list of items that match the filter query
    */
   find: (filterQuery: any) => Promise<any[]>,

package/src/helpers/useForceRender.tsx

@@ -0,0 +1,46 @@
+/* -------- State Definition -------- */
+
+type State = {
+  // The number of times the component has been forced to render
+  renderCount: number,
+};
+
+/* ------------- Reducer ------------ */
+
+/**
+ * Reducer that executes actions
+ * @author Gabe Abrams
+ * @param state current state
+ */
+const reducer = (state: State): State => {
+  return {
+    renderCount: state.renderCount + 1,
+  };
+};
+
+/* -------------- Main -------------- */
+
+/**
+ * Create a function that forces a render of a component. Use this only when
+ *   absolutely necessary
+ * @author Gabe Abrams
+ * @param useReducer the useReducer hook
+ * @returns forceRender function
+ */
+const useForceRender = (useReducer: any) => {
+  // Initial state
+  const initialState: State = {
+    renderCount: 0,
+  };
+
+  // Initialize state
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const [state, dispatch] = useReducer(reducer, initialState);
+
+  // Create and return the forceRender function
+  return () => {
+    dispatch();
+  };
+};
+
+export default useForceRender;

package/src/index.ts

@@ -83,6 +83,7 @@ import validateString from './helpers/validators/validateString';
 import idify from './helpers/idify';
 import makeLinksClickable from './helpers/makeLinksClickable';
 import combineClassNames from './helpers/combineClassNames';
+import prefixWithAOrAn from './helpers/prefixWithAOrAn';
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -177,6 +178,7 @@ export {
   getLocalTimeInfo,
   idify,
   makeLinksClickable,
+  prefixWithAOrAn,
   // Client helpers
   initClient,
   visitServerEndpoint,