dce-reactkit 3.2.0-beta.9 → 3.2.1

package/src/helpers/genRouteHandler.ts

@@ -25,6 +25,7 @@ import LogMainInfo from '../types/Log/LogMainInfo';
 import LogSourceSpecificInfo from '../types/Log/LogSourceSpecificInfo';
 import LogBuiltInMetadata from '../types/LogBuiltInMetadata';
 import LogAction from '../types/LogAction';
+import LogLevel from '../types/LogLevel';
 
 /**
  * Generate an express API route handler
@@ -508,24 +509,21 @@ 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 ?? {},
+          tags: (opts.tags ?? []),
+          level: (opts.level ?? LogLevel.Info),
+          metadata: (opts.metadata ?? {}),
         };
 
         // Type-specific info
@@ -617,9 +615,10 @@ const genRouteHandler = (
           minute: 1,
           timestamp: Date.now(),
           tags: [],
+          level: LogLevel.Warn,
           metadata: {},
-          category: LogBuiltInMetadata.Category.Uncategorized,
-          subcategory: LogBuiltInMetadata.Category.Uncategorized,
+          context: LogBuiltInMetadata.Context.Uncategorized,
+          subcontext: LogBuiltInMetadata.Context.Uncategorized,
         };
         
         const dummyTypeSpecificInfo: LogTypeSpecificInfo = {
@@ -699,7 +698,7 @@ const genRouteHandler = (
 
       // Log
       logServerEvent({
-        category: LogBuiltInMetadata.Category.ServerRenderedErrorPage,
+        context: LogBuiltInMetadata.Context.ServerRenderedErrorPage,
         error: {
           message: `${opts.title}: ${opts.description}`,
           code: opts.code,
@@ -740,7 +739,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

@@ -4,6 +4,7 @@ import ErrorWithCode from '../errors/ErrorWithCode';
 
 // Import shared helpers
 import genRouteHandler from '../helpers/genRouteHandler';
+import LogFunction from '../types/LogFunction';
 import ParamType from '../types/ParamType';
 
 // Import shared types
@@ -79,13 +80,14 @@ 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
+   * @param {string} level log level
    * @param {string} [errorMessage] error message if type is an error
    * @param {string} [errorCode] error code if type is an error
    * @param {string} [errorStack] error stack if type is an error
@@ -98,9 +100,10 @@ const initServer = (
     LOG_ROUTE_PATH,
     genRouteHandler({
       paramTypes: {
-        category: ParamType.String,
-        subcategory: ParamType.String,
+        context: ParamType.String,
+        subcontext: ParamType.String,
         tags: ParamType.JSON,
+        level: ParamType.String,
         metadata: ParamType.JSON,
         errorMessage: ParamType.StringOptional,
         errorCode: ParamType.StringOptional,
@@ -109,13 +112,15 @@ const initServer = (
         action: ParamType.StringOptional,
       },
       handler: ({ params, logServerEvent }) => {
-        const log = logServerEvent(
+        // Create log info
+        const logInfo: Parameters<LogFunction>[0] = (
           (params.errorMessage || params.errorCode || params.errorStack)
             // Error
             ? {
-              category: params.category,
-              subcategory: params.subcategory,
+              context: params.context,
+              subcontext: params.subcontext,
               tags: params.tags,
+              level: params.level,
               metadata: params.metadata,
               error: {
                 message: params.errorMessage,
@@ -125,15 +130,26 @@ const initServer = (
             }
             // Action
             : {
-              category: params.category,
-              subcategory: params.subcategory,
+              context: params.context,
+              subcontext: params.subcontext,
               tags: params.tags,
+              level: params.level,
               metadata: params.metadata,
               target: params.target,
               action: params.action,
             }
         );
 
+        // Add hidden boolean to change source to "client"
+        const logInfoForcedFromClient = {
+          ...logInfo,
+          overrideAsClientEvent: true,
+        };
+
+        // Write the log
+        const log = logServerEvent(logInfoForcedFromClient);
+
+        // Return
         return log;
       },
     }),

package/src/types/Log/LogMainInfo.ts

@@ -1,3 +1,6 @@
+// Import shared types
+import LogLevel from '../LogLevel';
+
 /**
  * Main information in a log event
  * @author Gabe Abrams
@@ -49,12 +52,14 @@ 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[],
+  // Log level
+  level: LogLevel,
   // Additional optional custom metadata
   metadata?: {
     [k: string]: any,

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

@@ -1,6 +1,7 @@
 // Import shared types
 import Log from './Log';
 import LogAction from './LogAction';
+import LogLevel from './LogLevel';
 
 /**
  * Type of a log action function
@@ -10,16 +11,18 @@ 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
       metadata?: {
         [k: string]: any,
       },
+      // Log level (default is info)
+      level?: LogLevel,
     } & (
       // Error
       | {

package/src/types/LogLevel.ts

@@ -0,0 +1,11 @@
+/**
+ * Allowed log levels
+ * @author Gabe Abrams
+ */
+enum LogLevel {
+  Warn = 'Warn',
+  Info = 'Info', // Default
+  Debug = 'Debug',
+}
+
+export default LogLevel;