dce-reactkit 3.3.3-beta.2 → 3.3.5

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

@@ -0,0 +1,19 @@
+/**
+ * Get current time info in local time
+ * @author Gabe Abrams
+ * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
+ * @returns object with timestamp (ms since epoch) and numbers
+ *   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) => {
+    timestamp: number;
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    hour12: number;
+    minute: number;
+    isPM: boolean;
+};
+export default getLocalTimeInfo;

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

@@ -2,9 +2,10 @@
  * Get current time info in US Boston Eastern Time, independent of machine
  *   timezone
  * @author Gabe Abrams
- * @param [date=now] the date to get info on or a ms since epoch timestamp
+ * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
  * @returns object with timestamp (ms since epoch) and numbers
- *   corresponding to ET time values for year, month, day, hour, minute
+ *   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) => {
     timestamp: number;
@@ -12,6 +13,8 @@ declare const getTimeInfoInET: (dateOrTimestamp?: number | Date | undefined) =>
     month: number;
     day: number;
     hour: number;
+    hour12: number;
     minute: number;
+    isPM: boolean;
 };
 export default getTimeInfoInET;

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

@@ -54,6 +54,7 @@ import canReviewLogs from './helpers/canReviewLogs';
 import isMobileOrTablet from './helpers/isMobileOrTablet';
 import extractProp from './helpers/extractProp';
 import compareArraysByProp from './helpers/compareArraysByProp';
+import getLocalTimeInfo from './helpers/getLocalTimeInfo';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -69,4 +70,4 @@ import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 import LogMetadataType from './types/LogMetadataType';
 import IntelliTableColumn from './types/IntelliTableColumn';
 import PickableItem from './components/ItemPicker/types/PickableItem';
-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, initClient, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, 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, getLocalTimeInfo, initClient, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, ParamType, };

package/dist/index.d.ts

@@ -899,9 +899,10 @@ declare const getOrdinal: (num: number) => string;
  * Get current time info in US Boston Eastern Time, independent of machine
  *   timezone
  * @author Gabe Abrams
- * @param [date=now] the date to get info on or a ms since epoch timestamp
+ * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
  * @returns object with timestamp (ms since epoch) and numbers
- *   corresponding to ET time values for year, month, day, hour, minute
+ *   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) => {
     timestamp: number;
@@ -909,7 +910,9 @@ declare const getTimeInfoInET: (dateOrTimestamp?: number | Date | undefined) =>
     month: number;
     day: number;
     hour: number;
+    hour12: number;
     minute: number;
+    isPM: boolean;
 };
 
 /**
@@ -1063,6 +1066,25 @@ declare const extractProp: (arr: any[], prop: string) => any[];
  */
 declare const compareArraysByProp: (a: any[], b: any[], prop: string) => boolean;
 
+/**
+ * Get current time info in local time
+ * @author Gabe Abrams
+ * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
+ * @returns object with timestamp (ms since epoch) and numbers
+ *   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) => {
+    timestamp: number;
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    hour12: number;
+    minute: number;
+    isPM: boolean;
+};
+
 /**
  * List of error codes built into the react kit
  * @author Gabe Abrams
@@ -1113,4 +1135,4 @@ declare const LogBuiltInMetadata: {
     };
 };
 
-export { AppWrapper, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, 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, alert, avg, canReviewLogs, ceilToNumDecimals, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genRouteHandler, getHumanReadableDate, 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, 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, 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 };

package/package.json

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

package/src/helpers/getLocalTimeInfo.tsx

@@ -0,0 +1,55 @@
+/**
+ * Get current time info in local time
+ * @author Gabe Abrams
+ * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
+ * @returns object with timestamp (ms since epoch) and numbers
+ *   corresponding to time values for year, month, day, hour, hour12, minute, isPM
+ *   where hour is in 24hr time and hour12 is in 12hr time.
+ */
+const getLocalTimeInfo = (dateOrTimestamp?: Date | number): {
+  timestamp: number,
+  year: number,
+  month: number,
+  day: number,
+  hour: number,
+  hour12: number,
+  minute: number,
+  isPM: boolean,
+} => {
+  // Create a time string
+  let d: Date;
+  if (!dateOrTimestamp) {
+    // Use now
+    d = new Date();
+  } else if (typeof dateOrTimestamp === 'number') {
+    // Convert to date
+    d = new Date(dateOrTimestamp);
+  } else {
+    // Already a date
+    d = dateOrTimestamp;
+  }
+
+  // Create all time numbers
+  const timestamp = d.getTime();
+  const year = d.getFullYear();
+  const month = d.getMonth() + 1;
+  const day = d.getDate();
+  const hour = d.getHours();
+  const isPM = hour >= 12;
+  const hour12 = hour % 12;
+  const minute = d.getMinutes();
+
+  // Return
+  return {
+    timestamp,
+    year,
+    month,
+    day,
+    hour,
+    hour12,
+    isPM,
+    minute,
+  };
+};
+
+export default getLocalTimeInfo;

package/src/helpers/getTimeInfoInET.tsx

@@ -2,9 +2,10 @@
  * Get current time info in US Boston Eastern Time, independent of machine
  *   timezone
  * @author Gabe Abrams
- * @param [date=now] the date to get info on or a ms since epoch timestamp
+ * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
  * @returns object with timestamp (ms since epoch) and numbers
- *   corresponding to ET time values for year, month, day, hour, minute
+ *   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.
  */
 const getTimeInfoInET = (dateOrTimestamp?: Date | number): {
   timestamp: number,
@@ -12,7 +13,9 @@ const getTimeInfoInET = (dateOrTimestamp?: Date | number): {
   month: number,
   day: number,
   hour: number,
+  hour12: number,
   minute: number,
+  isPM: boolean,
 } => {
   // Create a time string
   let d: Date;
@@ -42,13 +45,14 @@ const getTimeInfoInET = (dateOrTimestamp?: Date | number): {
   const month = Number.parseInt(monthStr, 10);
   const day = Number.parseInt(dayStr, 10);
   const minute = Number.parseInt(minStr, 10);
-  let hour = Number.parseInt(hourStr, 10);
+  let hour12 = Number.parseInt(hourStr, 10);
   // Convert from am/pm to 24hr
   const isAM = ending.toLowerCase().includes('am');
   const isPM = !isAM;
-  if (isPM && hour !== 12) {
+  let hour = hour12
+  if (isPM && hour12 !== 12) {
     hour += 12;
-  } else if (isAM && hour === 12) {
+  } else if (isAM && hour12 === 12) {
     hour = 0;
   }
 
@@ -59,6 +63,8 @@ const getTimeInfoInET = (dateOrTimestamp?: Date | number): {
     month,
     day,
     hour,
+    hour12,
+    isPM,
     minute,
   };
 };

package/src/index.ts

@@ -63,6 +63,7 @@ import canReviewLogs from './helpers/canReviewLogs';
 import isMobileOrTablet from './helpers/isMobileOrTablet';
 import extractProp from './helpers/extractProp';
 import compareArraysByProp from './helpers/compareArraysByProp';
+import getLocalTimeInfo from './helpers/getLocalTimeInfo';
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -142,6 +143,7 @@ export {
   isMobileOrTablet,
   extractProp,
   compareArraysByProp,
+  getLocalTimeInfo,
   // Client helpers
   initClient,
   visitServerEndpoint,