dce-reactkit 3.6.19 → 3.6.21

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

@@ -1,4 +1,16 @@
 import LogFunction from '../types/LogFunction';
+type MetadataPopulator = () => Promise<{
+    [k: string]: any;
+}>;
+/**
+ * Set the metadata populator function that will be called before every client
+ *   event is logged. The function should return a set of metadata values that
+ *   will be added to all client events
+ * @author Gabe Abrams
+ * @param metadataPopulator function to call that will return a set of metadata
+ *   values that will be added to all client events
+ */
+export declare const setClientEventMetadataPopulator: (newMetadataPopulator: MetadataPopulator) => void;
 /**
  * Log a user action on the client (cannot be used on the server)
  * @author Gabe Abrams

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

@@ -51,7 +51,7 @@ import getPartOfDay from './helpers/getPartOfDay';
 import stringsToHumanReadableList from './helpers/stringsToHumanReadableList';
 import onlyKeepLetters from './helpers/onlyKeepLetters';
 import parallelLimit from './helpers/parallelLimit';
-import logClientEvent from './helpers/logClientEvent';
+import logClientEvent, { setClientEventMetadataPopulator } from './helpers/logClientEvent';
 import initLogCollection from './server/initLogCollection';
 import getMonthName from './helpers/getMonthName';
 import genCSV from './helpers/genCSV';
@@ -88,4 +88,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, prefixWithAOrAn, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, 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, useForceRender, setClientEventMetadataPopulator, 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/types/LogAction.d.ts

@@ -18,6 +18,8 @@ declare enum LogAction {
     Activate = "Activate",
     Deactivate = "Deactivate",
     Peek = "Peek",
+    Halt = "Halt",
+    Resume = "Resume",
     Unknown = "Unknown"
 }
 export default LogAction;

package/dist/index.d.ts

@@ -931,6 +931,8 @@ declare enum LogAction {
     Activate = "Activate",
     Deactivate = "Deactivate",
     Peek = "Peek",
+    Halt = "Halt",
+    Resume = "Resume",
     Unknown = "Unknown"
 }
 
@@ -1186,6 +1188,18 @@ declare const onlyKeepLetters: (str: string) => string;
  */
 declare const parallelLimit: (taskFunctions: (() => Promise<any>)[], limit?: number) => Promise<any[]>;
 
+type MetadataPopulator = () => Promise<{
+    [k: string]: any;
+}>;
+/**
+ * Set the metadata populator function that will be called before every client
+ *   event is logged. The function should return a set of metadata values that
+ *   will be added to all client events
+ * @author Gabe Abrams
+ * @param metadataPopulator function to call that will return a set of metadata
+ *   values that will be added to all client events
+ */
+declare const setClientEventMetadataPopulator: (newMetadataPopulator: MetadataPopulator) => void;
 /**
  * Log a user action on the client (cannot be used on the server)
  * @author Gabe Abrams
@@ -1495,4 +1509,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, prefixWithAOrAn, roundToNumDecimals, showFatalError, 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, 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, setClientEventMetadataPopulator, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };

package/package.json

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

package/src/helpers/logClientEvent.tsx

@@ -7,11 +7,54 @@ import LogLevel from '../types/LogLevel';
 // Import shared functions
 import visitServerEndpoint from './visitServerEndpoint';
 
+/* ------- Metadata Populator ------- */
+
+// Type of a metadata populator function
+type MetadataPopulator = () => Promise<{ [k: string]: any }>;
+
+// Current metadata populator function
+let metadataPopulator: MetadataPopulator;
+
+/**
+ * Set the metadata populator function that will be called before every client
+ *   event is logged. The function should return a set of metadata values that
+ *   will be added to all client events
+ * @author Gabe Abrams
+ * @param metadataPopulator function to call that will return a set of metadata
+ *   values that will be added to all client events
+ */
+export const setClientEventMetadataPopulator = (
+  newMetadataPopulator: MetadataPopulator,
+) => {
+  metadataPopulator = newMetadataPopulator;
+};
+
+/* -------------- Main -------------- */
+
 /**
  * Log a user action on the client (cannot be used on the server)
  * @author Gabe Abrams
  */
 const logClientEvent: LogFunction = async (opts) => {
+  // Populate metadata
+  let metadata = (opts.metadata ?? {});
+  if (metadataPopulator) {
+    try {
+      const autoPopulatedMetadata = await metadataPopulator();
+      metadata = {
+        ...autoPopulatedMetadata,
+        ...metadata,
+      };
+    } catch (err) {
+      // Add error to metadata
+      metadata = {
+        autoPopulatedMetadataNotAvailable: true,
+        ...metadata,
+      };
+    }
+  }
+
+  // Send to server
   return visitServerEndpoint({
     path: LOG_ROUTE_PATH,
     method: 'POST',
@@ -33,7 +76,7 @@ const logClientEvent: LogFunction = async (opts) => {
         ?? LogLevel.Info
       ),
       tags: JSON.stringify(opts.tags ?? []),
-      metadata: JSON.stringify(opts.metadata ?? {}),
+      metadata: JSON.stringify(metadata),
       errorMessage: (
         (opts as any).error
           ? (opts as any).error.message

package/src/index.ts

@@ -66,7 +66,7 @@ import getPartOfDay from './helpers/getPartOfDay';
 import stringsToHumanReadableList from './helpers/stringsToHumanReadableList';
 import onlyKeepLetters from './helpers/onlyKeepLetters';
 import parallelLimit from './helpers/parallelLimit';
-import logClientEvent from './helpers/logClientEvent';
+import logClientEvent, { setClientEventMetadataPopulator } from './helpers/logClientEvent';
 import initLogCollection from './server/initLogCollection';
 import getMonthName from './helpers/getMonthName';
 import genCSV from './helpers/genCSV';
@@ -188,6 +188,7 @@ export {
   leaveToURL,
   combineClassNames,
   useForceRender,
+  setClientEventMetadataPopulator,
   // Server helpers
   initServer,
   genRouteHandler,

package/src/types/LogAction.ts

@@ -33,8 +33,12 @@ enum LogAction {
   Deactivate = 'Deactivate',
   // User showed interest in a target (hover, peek, etc.)
   Peek = 'Peek',
+  // Halt a process (pause, etc.)
+  Halt = 'Halt',
+  // Resume a process (resume a halted process)
+  Resume = 'Resume',
   // Unknown action
   Unknown = 'Unknown',
-};
+}
 
 export default LogAction;

package/src/types/LogType.ts

@@ -7,6 +7,6 @@ enum LogType {
   Action = 'action',
   // Error
   Error = 'error',
-};
+}
 
 export default LogType;