dce-reactkit 3.2.0-beta.9 → 3.2.0

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/LogBuiltInMetadata';
+import LogBuiltInMetadata 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, };
+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, LogBuiltInMetadata, PickableItem, ParamType, };

package/dist/esm/types/types/Log/LogMainInfo.d.ts

@@ -27,8 +27,8 @@ declare type LogMainInfo = {
     hour: number;
     minute: number;
     timestamp: number;
-    category: string;
-    subcategory: string;
+    context: string;
+    subcontext: string;
     tags: string[];
     metadata?: {
         [k: string]: any;

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

@@ -1,9 +1,9 @@
 /**
- * Built-in categories for logs
+ * Built-in metadata for logs
  * @author Gabe Abrams
  */
 declare const LogBuiltInMetadata: {
-    Category: {
+    Context: {
         Uncategorized: string;
         ServerRenderedErrorPage: string;
         ServerEndpointError: string;

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

@@ -5,12 +5,10 @@ import LogAction from './LogAction';
  * @author Gabe Abrams
  */
 declare type LogFunction = (opts: ({
-    category: string | {
-        _: string;
-    };
-    subcategory?: string | {
+    context: string | {
         _: string;
     };
+    subcontext?: string;
     tags?: string[];
     metadata?: {
         [k: string]: any;

package/dist/index.d.ts

@@ -544,8 +544,8 @@ declare type LogMainInfo = {
     hour: number;
     minute: number;
     timestamp: number;
-    category: string;
-    subcategory: string;
+    context: string;
+    subcontext: string;
     tags: string[];
     metadata?: {
         [k: string]: any;
@@ -632,12 +632,10 @@ declare type Log = (LogMainInfo & LogSourceSpecificInfo & LogTypeSpecificInfo);
  * @author Gabe Abrams
  */
 declare type LogFunction = (opts: ({
-    category: string | {
-        _: string;
-    };
-    subcategory?: string | {
+    context: string | {
         _: string;
     };
+    subcontext?: string;
     tags?: string[];
     metadata?: {
         [k: string]: any;
@@ -883,11 +881,11 @@ declare enum DayOfWeek {
 }
 
 /**
- * Built-in categories for logs
+ * Built-in metadata for logs
  * @author Gabe Abrams
  */
 declare const LogBuiltInMetadata: {
-    Category: {
+    Context: {
         Uncategorized: string;
         ServerRenderedErrorPage: string;
         ServerEndpointError: string;
@@ -897,4 +895,4 @@ declare const LogBuiltInMetadata: {
     };
 };
 
-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 };
+export { AppWrapper, ButtonInputGroup, CheckboxButton, CopiableBox, DAY_IN_MS, DayOfWeek, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, 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.9",
+  "version": "3.2.0",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/helpers/genRouteHandler.ts

@@ -508,21 +508,17 @@ const genRouteHandler = (
           hour,
           minute,
           timestamp,
-          category: (
-            typeof opts.category === 'string'
-              ? opts.category
+          context: (
+            typeof opts.context === 'string'
+              ? opts.context
               : (
-                ((opts.category as any) ?? {})._
-                ?? LogBuiltInMetadata.Category.Uncategorized
+                ((opts.context as any) ?? {})._
+                ?? LogBuiltInMetadata.Context.Uncategorized
               )
           ),
-          subcategory: (
-            typeof opts.category === 'string'
-              ? opts.subcategory
-              : (
-                ((opts.subcategory as any) ?? {})._
-                ?? LogBuiltInMetadata.Category.Uncategorized
-              )
+          subcontext: (
+            opts.subcontext
+            ?? LogBuiltInMetadata.Context.Uncategorized
           ),
           tags: opts.tags ?? [],
           metadata: opts.metadata ?? {},
@@ -618,8 +614,8 @@ const genRouteHandler = (
           timestamp: Date.now(),
           tags: [],
           metadata: {},
-          category: LogBuiltInMetadata.Category.Uncategorized,
-          subcategory: LogBuiltInMetadata.Category.Uncategorized,
+          context: LogBuiltInMetadata.Context.Uncategorized,
+          subcontext: LogBuiltInMetadata.Context.Uncategorized,
         };
         
         const dummyTypeSpecificInfo: LogTypeSpecificInfo = {
@@ -699,7 +695,7 @@ const genRouteHandler = (
 
       // Log
       logServerEvent({
-        category: LogBuiltInMetadata.Category.ServerRenderedErrorPage,
+        context: LogBuiltInMetadata.Context.ServerRenderedErrorPage,
         error: {
           message: `${opts.title}: ${opts.description}`,
           code: opts.code,
@@ -740,7 +736,7 @@ const genRouteHandler = (
 
         // Log server-side error
         logServerEvent({
-          category: LogBuiltInMetadata.Category.ServerEndpointError,
+          context: LogBuiltInMetadata.Context.ServerEndpointError,
           error: err,
         });
 

package/src/helpers/logClientEvent.tsx

@@ -15,21 +15,17 @@ const logClientEvent: LogFunction = async (opts) => {
     path: LOG_ROUTE_PATH,
     method: 'POST',
     params: {
-      category: (
-        typeof opts.category === 'string'
-          ? opts.category
+      context: (
+        typeof opts.context === 'string'
+          ? opts.context
           : (
-            ((opts.category as any) ?? {})._
-            ?? LogBuiltInMetadata.Category.Uncategorized
+            ((opts.context as any) ?? {})._
+            ?? LogBuiltInMetadata.Context.Uncategorized
           )
       ),
-      subcategory: (
-        typeof opts.category === 'string'
-          ? opts.subcategory
-          : (
-            ((opts.subcategory as any) ?? {})._
-            ?? LogBuiltInMetadata.Category.Uncategorized
-          )
+      subcontext: (
+        opts.subcontext
+        ?? LogBuiltInMetadata.Context.Uncategorized
       ),
       tags: JSON.stringify(opts.tags ?? []),
       metadata: JSON.stringify(opts.metadata ?? {}),

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/LogBuiltInMetadata';
+import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 
 // Component-specific-types
 import PickableItem from './components/ItemPicker/types/PickableItem';
@@ -136,7 +136,7 @@ export {
   LogType,
   LogSource,
   LogAction,
-  LogBuiltInCategory,
+  LogBuiltInMetadata,
   // Component-specific-types
   PickableItem,
   // Server types

package/src/server/initLogCollection.ts

@@ -11,8 +11,8 @@ const initLogCollection = (Collection: any) => {
       uniqueIndexKey: 'id',
       indexKeys: [
         'courseId',
-        'category',
-        'subcategory',
+        'context',
+        'subcontext',
         'tags',
       ],
     },

package/src/server/initServer.ts

@@ -79,10 +79,10 @@ const initServer = (
   /**
    * Log an event
    * @author Gabe Abrams
-   * @param {string} category Category of the event (each app determines how to
-   *   categorize its events)
-   * @param {string} subcategory Subcategory of the event (each app determines
-   *   how to categorize its events)
+   * @param {string} context Context of the event (each app determines how to
+   *   organize its contexts)
+   * @param {string} subcontext Subcontext of the event (each app determines
+   *   how to organize its subcontexts)
    * @param {string} tags stringified list of tags that apply to this action
    *   (each app determines tag usage)
    * @param {string} metadata stringified object containing optional custom metadata
@@ -98,8 +98,8 @@ const initServer = (
     LOG_ROUTE_PATH,
     genRouteHandler({
       paramTypes: {
-        category: ParamType.String,
-        subcategory: ParamType.String,
+        context: ParamType.String,
+        subcontext: ParamType.String,
         tags: ParamType.JSON,
         metadata: ParamType.JSON,
         errorMessage: ParamType.StringOptional,
@@ -113,8 +113,8 @@ const initServer = (
           (params.errorMessage || params.errorCode || params.errorStack)
             // Error
             ? {
-              category: params.category,
-              subcategory: params.subcategory,
+              context: params.context,
+              subcontext: params.subcontext,
               tags: params.tags,
               metadata: params.metadata,
               error: {
@@ -125,8 +125,8 @@ const initServer = (
             }
             // Action
             : {
-              category: params.category,
-              subcategory: params.subcategory,
+              context: params.context,
+              subcontext: params.subcontext,
               tags: params.tags,
               metadata: params.metadata,
               target: params.target,

package/src/types/Log/LogMainInfo.ts

@@ -49,10 +49,10 @@ type LogMainInfo = {
   minute: number,
   // Timestamp of event (ms since epoch)
   timestamp: number,
-  // Category of the event (each app determines how to categorize its events)
-  category: string,
-  // Subcategory of the event (each app determines how to categorize its events)
-  subcategory: string,
+  // Context of the event (each app determines how to organize contexts)
+  context: string,
+  // Subcontext of the event (each app determines how to organize subcontexts)
+  subcontext: string,
   // List of tags that apply to this action (each app determines tag usage)
   tags: string[],
   // Additional optional custom metadata

package/src/types/LogBuiltInMetadata.ts

@@ -1,10 +1,10 @@
 /**
- * Built-in categories for logs
+ * Built-in metadata for logs
  * @author Gabe Abrams
  */
 const LogBuiltInMetadata = {
-  // Categories
-  Category: {
+  // Contexts
+  Context: {
     Uncategorized: 'n/a',
     ServerRenderedErrorPage: '_server-rendered-error-page',
     ServerEndpointError: '_server-endpoint-error',

package/src/types/LogFunction.ts

@@ -10,10 +10,10 @@ type LogFunction = (
   opts: (
     // Shared info
     {
-      // Category of the event (each app determines how to categorize its events)
-      category: string | { _: string },
-      // Subcategory of the event (each app determines how to categorize its events)
-      subcategory?: string | { _: string },
+      // Context of the event (each app determines how to organize contexts)
+      context: string | { _: string },
+      // Subcontext of the event (each app determines how to organize subcontexts)
+      subcontext?: string,
       // List of tags that apply to this action (each app determines tag usage)
       tags?: string[],
       // Additional optional custom metadata