dce-reactkit 4.1.3 → 4.1.5

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

@@ -6,6 +6,7 @@ import React from 'react';
 type Props = {
     filename: string;
     csv: string;
+    label?: string;
     id?: string;
     className?: string;
     ariaLabel?: string;

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

@@ -0,0 +1,20 @@
+/**
+ * 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/esm/types/index.d.ts

@@ -79,6 +79,7 @@ import capitalize from './helpers/capitalize';
 import shuffleArray from './helpers/shuffleArray';
 import getWordCount from './helpers/getWordCount';
 import cloneDeep from './helpers/cloneDeep';
+import getTimestampFromTimeInfoInET from './helpers/getTimestampFromTimeInfoInET';
 import ParamType from './types/ParamType';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
@@ -104,4 +105,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, SimpleTimeChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, Dropdown, alert, prompt, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_ROUTE_PATH, LOG_REVIEW_STATUS_ROUTE, LOG_REVIEW_GET_LOGS_ROUTE, 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, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, getWordCount, cloneDeep, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, ParamType, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, LogTypeSpecificInfo, LogMainInfo, LogSourceSpecificInfo, LogLevel, IntelliTableColumn, DropdownItemType, LogReviewerFilterState, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, SimpleTimeChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, Dropdown, alert, prompt, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_ROUTE_PATH, LOG_REVIEW_STATUS_ROUTE, LOG_REVIEW_GET_LOGS_ROUTE, 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, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, getWordCount, cloneDeep, getTimestampFromTimeInfoInET, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, ParamType, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, LogTypeSpecificInfo, LogMainInfo, LogSourceSpecificInfo, LogLevel, IntelliTableColumn, DropdownItemType, LogReviewerFilterState, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, };

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

@@ -8,6 +8,7 @@ declare enum ReactKitErrorCode {
     SessionExpired = "DRK3",
     NoCACCLSendRequestFunction = "DRK7",
     SimpleDateChooserInvalidDateRange = "DRK35",
-    SimpleDateChooserInvalidNumMonths = "DRK36"
+    SimpleDateChooserInvalidNumMonths = "DRK36",
+    ETTimestampInvalid = "DRK37"
 }
 export default ReactKitErrorCode;

package/dist/index.d.ts

@@ -543,6 +543,7 @@ declare const IntelliTable: React$1.FC<Props$7>;
 type Props$6 = {
     filename: string;
     csv: string;
+    label?: string;
     id?: string;
     className?: string;
     ariaLabel?: string;
@@ -1553,6 +1554,26 @@ declare const getWordCount: (text: string) => number;
  */
 declare const cloneDeep: <T>(obj: T) => T;
 
+/**
+ * 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;
+
 /**
  * Days of the week
  * @author Gabe Abrams
@@ -1593,7 +1614,8 @@ declare enum ReactKitErrorCode {
     SessionExpired = "DRK3",
     NoCACCLSendRequestFunction = "DRK7",
     SimpleDateChooserInvalidDateRange = "DRK35",
-    SimpleDateChooserInvalidNumMonths = "DRK36"
+    SimpleDateChooserInvalidNumMonths = "DRK36",
+    ETTimestampInvalid = "DRK37"
 }
 
 /**
@@ -1679,4 +1701,4 @@ type LogReviewerFilterState = {
     advancedFilterState: AdvancedFilterState;
 };
 
-export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, Dropdown, DropdownItemType, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LOG_REVIEW_GET_LOGS_ROUTE, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_REVIEW_STATUS_ROUTE, LOG_ROUTE_PATH, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogLevel, LogMainInfo, LogMetadataType, LogReviewer, LogReviewerFilterState, LogSource, LogSourceSpecificInfo, LogType, LogTypeSpecificInfo, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, SimpleTimeChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addFatalErrorHandler, alert, avg, canReviewLogs, capitalize, ceilToNumDecimals, cloneDeep, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, getWordCount, idify, initClient, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, prompt, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };
+export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, Dropdown, DropdownItemType, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LOG_REVIEW_GET_LOGS_ROUTE, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_REVIEW_STATUS_ROUTE, LOG_ROUTE_PATH, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogLevel, LogMainInfo, LogMetadataType, LogReviewer, LogReviewerFilterState, LogSource, LogSourceSpecificInfo, LogType, LogTypeSpecificInfo, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, SimpleTimeChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addFatalErrorHandler, alert, avg, canReviewLogs, capitalize, ceilToNumDecimals, cloneDeep, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, getTimestampFromTimeInfoInET, getWordCount, idify, initClient, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, prompt, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };

package/package.json

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

package/src/components/CSVDownloadButton.tsx

@@ -20,6 +20,8 @@ type Props = {
   filename: string,
   // The contents of the CSV file to download
   csv: string,
+  // Label for the button
+  label?: string,
   // Id of the button
   id?: string,
   // Class name of the button
@@ -55,6 +57,7 @@ const CSVDownloadButton: React.FC<Props> = (props) => {
     style,
     onClick,
     children,
+    label = 'Download CSV',
   } = props;
 
   /*------------------------------------------------------------------------*/
@@ -86,7 +89,7 @@ const CSVDownloadButton: React.FC<Props> = (props) => {
             icon={faCloudDownloadAlt}
           />
           {' '}
-          Download CSV
+          {label}
         </>
       )}
       {children}

package/src/helpers/genCSV.ts

@@ -59,6 +59,7 @@ const genCSV = (
           if (
             typeof cell === 'string'
             || typeof cell === 'number'
+            || typeof cell === 'boolean'
           ) {
             contents = String(cell);
           } else if (cell === null) {

package/src/helpers/getTimestampFromTimeInfoInET.ts

@@ -0,0 +1,74 @@
+// Import shared types
+import ErrorWithCode from '../errors/ErrorWithCode';
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
+// Import shared helpers
+import getTimeInfoInET from './getTimeInfoInET';
+import padZerosLeft from './padZerosLeft';
+
+/**
+ * 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
+ */
+const getTimestampFromTimeInfoInET = (
+  opts: {
+    year: number,
+    month: number,
+    day: number,
+    hour: number,
+    minute: number,
+  },
+): number => {
+  // Destructure opts
+  const {
+    year,
+    month,
+    day,
+    hour,
+    minute,
+  } = opts;
+
+  // Determine if the date is in DST in Eastern Time
+  const tempDate = new Date(year, month - 1, day);
+  const janOffset = new Date(year, 0, 1).getTimezoneOffset();
+  const isDST = tempDate.getTimezoneOffset() < janOffset;
+  const etOffset = isDST ? '-04:00' : '-05:00';
+
+  // Format with leading zeroes
+  const mm = padZerosLeft(month, 2);
+  const dd = padZerosLeft(day, 2);
+  const hh = padZerosLeft(hour, 2);
+  const min = padZerosLeft(minute, 2);
+
+  // Build ET ISO string and convert to UTC timestamp
+  const etISOString = `${year}-${mm}-${dd}T${hh}:${min}:00${etOffset}`;
+  const timestamp = (new Date(etISOString)).getTime();
+
+  // Verify that the timestamp is correct
+  const timeInfoInET = getTimeInfoInET(timestamp);
+  if (
+    timeInfoInET.year !== year
+    || timeInfoInET.month !== month
+    || timeInfoInET.day !== day
+    || timeInfoInET.hour !== hour
+    || timeInfoInET.minute !== minute
+  ) {
+    throw new ErrorWithCode(
+      `Timestamp mismatch: expected ${year}-${mm}-${dd} ${hh}:${min}, got ${timeInfoInET.year}-${padZerosLeft(timeInfoInET.month, 2)}-${padZerosLeft(timeInfoInET.day, 2)} ${padZerosLeft(timeInfoInET.hour, 2)}:${padZerosLeft(timeInfoInET.minute, 2)}`,
+      ReactKitErrorCode.ETTimestampInvalid,
+    );
+  }
+
+  // Valid! Return the timestamp
+  return timestamp;
+};
+
+export default getTimestampFromTimeInfoInET;

package/src/index.ts

@@ -95,6 +95,7 @@ import capitalize from './helpers/capitalize';
 import shuffleArray from './helpers/shuffleArray';
 import getWordCount from './helpers/getWordCount';
 import cloneDeep from './helpers/cloneDeep';
+import getTimestampFromTimeInfoInET from './helpers/getTimestampFromTimeInfoInET';
 
 // Import types
 import ParamType from './types/ParamType';
@@ -213,6 +214,7 @@ export {
   shuffleArray,
   getWordCount,
   cloneDeep,
+  getTimestampFromTimeInfoInET,
   // Client helpers
   initClient,
   visitServerEndpoint,

package/src/types/ReactKitErrorCode.tsx

@@ -1,4 +1,4 @@
-// Highest error code = DRK36
+// Highest error code = DRK37
 
 /**
  * List of error codes built into the react kit
@@ -11,6 +11,7 @@ enum ReactKitErrorCode {
   NoCACCLSendRequestFunction = 'DRK7',
   SimpleDateChooserInvalidDateRange = 'DRK35',
   SimpleDateChooserInvalidNumMonths = 'DRK36',
+  ETTimestampInvalid = 'DRK37',
 }
 
 export default ReactKitErrorCode;