dce-reactkit 3.2.0-beta.8 → 3.2.0-beta.9

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

@@ -54,6 +54,6 @@ import Log from './types/Log';
 import LogType from './types/LogType';
 import LogSource from './types/LogSource';
 import LogAction from './types/LogAction';
-import LogBuiltInCategory from './types/LogBuiltInCategory';
+import LogBuiltInCategory from './types/LogBuiltInMetadata';
 import PickableItem from './components/ItemPicker/types/PickableItem';
 export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, visitServerEndpoint, logClientEvent, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInCategory, PickableItem, ParamType, };

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

@@ -0,0 +1,15 @@
+/**
+ * Built-in categories for logs
+ * @author Gabe Abrams
+ */
+declare const LogBuiltInMetadata: {
+    Category: {
+        Uncategorized: string;
+        ServerRenderedErrorPage: string;
+        ServerEndpointError: string;
+    };
+    Target: {
+        NoSpecificTarget: string;
+    };
+};
+export default LogBuiltInMetadata;

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

@@ -18,7 +18,7 @@ declare type LogFunction = (opts: ({
 } & ({
     error: any;
 } | {
-    target: string;
     action: LogAction;
+    target?: string;
 }))) => Promise<Log>;
 export default LogFunction;

package/dist/index.d.ts

@@ -645,8 +645,8 @@ declare type LogFunction = (opts: ({
 } & ({
     error: any;
 } | {
-    target: string;
     action: LogAction;
+    target?: string;
 }))) => Promise<Log>;
 
 /**
@@ -886,10 +886,15 @@ declare enum DayOfWeek {
  * Built-in categories for logs
  * @author Gabe Abrams
  */
-declare enum LogBuiltInCategory {
-    Uncategorized = "n/a",
-    ServerRenderedErrorPage = "_server-rendered-error-page",
-    ServerEndpointError = "_server-endpoint-error"
-}
+declare const LogBuiltInMetadata: {
+    Category: {
+        Uncategorized: string;
+        ServerRenderedErrorPage: string;
+        ServerEndpointError: string;
+    };
+    Target: {
+        NoSpecificTarget: string;
+    };
+};
 
-export { AppWrapper, ButtonInputGroup, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInCategory, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genRouteHandler, getHumanReadableDate, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initLogCollection, initServer, logClientEvent, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, visitServerEndpoint, waitMs };
+export { AppWrapper, ButtonInputGroup, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata as LogBuiltInCategory, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genRouteHandler, getHumanReadableDate, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, initLogCollection, initServer, 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.2.0-beta.8",
+  "version": "3.2.0-beta.9",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/helpers/genRouteHandler.ts

@@ -23,7 +23,8 @@ import LogSource from '../types/LogSource';
 import LogTypeSpecificInfo from '../types/Log/LogTypeSpecificInfo';
 import LogMainInfo from '../types/Log/LogMainInfo';
 import LogSourceSpecificInfo from '../types/Log/LogSourceSpecificInfo';
-import LogBuiltInCategory from '../types/LogBuiltInCategory';
+import LogBuiltInMetadata from '../types/LogBuiltInMetadata';
+import LogAction from '../types/LogAction';
 
 /**
  * Generate an express API route handler
@@ -512,7 +513,7 @@ const genRouteHandler = (
               ? opts.category
               : (
                 ((opts.category as any) ?? {})._
-                ?? LogBuiltInCategory.Uncategorized
+                ?? LogBuiltInMetadata.Category.Uncategorized
               )
           ),
           subcategory: (
@@ -520,7 +521,7 @@ const genRouteHandler = (
               ? opts.subcategory
               : (
                 ((opts.subcategory as any) ?? {})._
-                ?? LogBuiltInCategory.Uncategorized
+                ?? LogBuiltInMetadata.Category.Uncategorized
               )
           ),
           tags: opts.tags ?? [],
@@ -538,8 +539,14 @@ const genRouteHandler = (
             }
             : {
               type: LogType.Action,
-              target: (opts as any).target ?? 'Unknown',
-              action: (opts as any).action ?? 'Unknown'
+              target: (
+                (opts as any).target
+                ?? LogBuiltInMetadata.Target.NoSpecificTarget
+              ),
+              action: (
+                (opts as any).action
+                ?? LogAction.Unknown
+              ),
             }
         );
 
@@ -611,8 +618,8 @@ const genRouteHandler = (
           timestamp: Date.now(),
           tags: [],
           metadata: {},
-          category: LogBuiltInCategory.Uncategorized,
-          subcategory: LogBuiltInCategory.Uncategorized,
+          category: LogBuiltInMetadata.Category.Uncategorized,
+          subcategory: LogBuiltInMetadata.Category.Uncategorized,
         };
         
         const dummyTypeSpecificInfo: LogTypeSpecificInfo = {
@@ -692,7 +699,7 @@ const genRouteHandler = (
 
       // Log
       logServerEvent({
-        category: LogBuiltInCategory.ServerRenderedErrorPage,
+        category: LogBuiltInMetadata.Category.ServerRenderedErrorPage,
         error: {
           message: `${opts.title}: ${opts.description}`,
           code: opts.code,
@@ -733,7 +740,7 @@ const genRouteHandler = (
 
         // Log server-side error
         logServerEvent({
-          category: LogBuiltInCategory.ServerEndpointError,
+          category: LogBuiltInMetadata.Category.ServerEndpointError,
           error: err,
         });
 

package/src/helpers/logClientEvent.tsx

@@ -1,6 +1,6 @@
 // Import shared types
 import LOG_ROUTE_PATH from '../constants/LOG_ROUTE_PATH';
-import LogBuiltInCategory from '../types/LogBuiltInCategory';
+import LogBuiltInMetadata from '../types/LogBuiltInMetadata';
 import LogFunction from '../types/LogFunction';
 
 // Import shared functions
@@ -20,7 +20,7 @@ const logClientEvent: LogFunction = async (opts) => {
           ? opts.category
           : (
             ((opts.category as any) ?? {})._
-            ?? LogBuiltInCategory.Uncategorized
+            ?? LogBuiltInMetadata.Category.Uncategorized
           )
       ),
       subcategory: (
@@ -28,7 +28,7 @@ const logClientEvent: LogFunction = async (opts) => {
           ? opts.subcategory
           : (
             ((opts.subcategory as any) ?? {})._
-            ?? LogBuiltInCategory.Uncategorized
+            ?? LogBuiltInMetadata.Category.Uncategorized
           )
       ),
       tags: JSON.stringify(opts.tags ?? []),
@@ -49,8 +49,11 @@ const logClientEvent: LogFunction = async (opts) => {
           : undefined
       ),
       target: (
-        (opts as any).target
-          ? (opts as any).target
+        (opts as any).action
+          ? (
+            (opts as any).target
+            ?? LogBuiltInMetadata.Target.NoSpecificTarget
+          )
           : undefined
       ),
       action: (

package/src/index.ts

@@ -63,7 +63,7 @@ import Log from './types/Log';
 import LogType from './types/LogType';
 import LogSource from './types/LogSource';
 import LogAction from './types/LogAction';
-import LogBuiltInCategory from './types/LogBuiltInCategory';
+import LogBuiltInCategory from './types/LogBuiltInMetadata';
 
 // Component-specific-types
 import PickableItem from './components/ItemPicker/types/PickableItem';

package/src/types/LogBuiltInMetadata.ts

@@ -0,0 +1,18 @@
+/**
+ * Built-in categories for logs
+ * @author Gabe Abrams
+ */
+const LogBuiltInMetadata = {
+  // Categories
+  Category: {
+    Uncategorized: 'n/a',
+    ServerRenderedErrorPage: '_server-rendered-error-page',
+    ServerEndpointError: '_server-endpoint-error',
+  },
+  // Targets
+  Target: {
+    NoSpecificTarget: 'n/a',
+  },
+};
+
+export default LogBuiltInMetadata;

package/src/types/LogFunction.ts

@@ -28,11 +28,13 @@ type LogFunction = (
       }
       // Action
       | {
+        // The type of action performed
+        action: LogAction,
         // Target of the action (each app determines the list of targets)
         // These are usually buttons, panels, elements, etc.
-        target: string,
-        // The type of action performed on the target
-        action: LogAction,
+        // If no target is included, this should indicate that this is an action
+        // being performed on the whole feature (open/close/etc)
+        target?: string,
       }
     )
   ),

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

@@ -1,10 +0,0 @@
-/**
- * Built-in categories for logs
- * @author Gabe Abrams
- */
-declare enum LogBuiltInCategory {
-    Uncategorized = "n/a",
-    ServerRenderedErrorPage = "_server-rendered-error-page",
-    ServerEndpointError = "_server-endpoint-error"
-}
-export default LogBuiltInCategory;

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

@@ -1,10 +0,0 @@
-/**
- * Built-in categories for logs
- * @author Gabe Abrams
- */
-declare enum LogBuiltInCategory {
-    Uncategorized = "n/a",
-    ServerRenderedErrorPage = "_server-rendered-error-page",
-    ServerEndpointError = "_server-endpoint-error"
-}
-export default LogBuiltInCategory;

package/src/types/LogBuiltInCategory.ts

@@ -1,11 +0,0 @@
-/**
- * Built-in categories for logs
- * @author Gabe Abrams
- */
-enum LogBuiltInCategory {
-  Uncategorized = 'n/a',
-  ServerRenderedErrorPage = '_server-rendered-error-page',
-  ServerEndpointError = '_server-endpoint-error',
-};
-
-export default LogBuiltInCategory;