dce-reactkit 3.2.0-beta.8 → 3.2.0

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
@@ -507,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) ?? {})._
-                ?? LogBuiltInCategory.Uncategorized
+                ((opts.context as any) ?? {})._
+                ?? LogBuiltInMetadata.Context.Uncategorized
               )
           ),
-          subcategory: (
-            typeof opts.category === 'string'
-              ? opts.subcategory
-              : (
-                ((opts.subcategory as any) ?? {})._
-                ?? LogBuiltInCategory.Uncategorized
-              )
+          subcontext: (
+            opts.subcontext
+            ?? LogBuiltInMetadata.Context.Uncategorized
           ),
           tags: opts.tags ?? [],
           metadata: opts.metadata ?? {},
@@ -538,8 +535,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 +614,8 @@ const genRouteHandler = (
           timestamp: Date.now(),
           tags: [],
           metadata: {},
-          category: LogBuiltInCategory.Uncategorized,
-          subcategory: LogBuiltInCategory.Uncategorized,
+          context: LogBuiltInMetadata.Context.Uncategorized,
+          subcontext: LogBuiltInMetadata.Context.Uncategorized,
         };
         
         const dummyTypeSpecificInfo: LogTypeSpecificInfo = {
@@ -692,7 +695,7 @@ const genRouteHandler = (
 
       // Log
       logServerEvent({
-        category: LogBuiltInCategory.ServerRenderedErrorPage,
+        context: LogBuiltInMetadata.Context.ServerRenderedErrorPage,
         error: {
           message: `${opts.title}: ${opts.description}`,
           code: opts.code,
@@ -733,7 +736,7 @@ const genRouteHandler = (
 
         // Log server-side error
         logServerEvent({
-          category: LogBuiltInCategory.ServerEndpointError,
+          context: LogBuiltInMetadata.Context.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
@@ -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) ?? {})._
-            ?? LogBuiltInCategory.Uncategorized
+            ((opts.context as any) ?? {})._
+            ?? LogBuiltInMetadata.Context.Uncategorized
           )
       ),
-      subcategory: (
-        typeof opts.category === 'string'
-          ? opts.subcategory
-          : (
-            ((opts.subcategory as any) ?? {})._
-            ?? LogBuiltInCategory.Uncategorized
-          )
+      subcontext: (
+        opts.subcontext
+        ?? LogBuiltInMetadata.Context.Uncategorized
       ),
       tags: JSON.stringify(opts.tags ?? []),
       metadata: JSON.stringify(opts.metadata ?? {}),
@@ -49,8 +45,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 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

@@ -0,0 +1,18 @@
+/**
+ * Built-in metadata for logs
+ * @author Gabe Abrams
+ */
+const LogBuiltInMetadata = {
+  // Contexts
+  Context: {
+    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

@@ -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
@@ -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;