dce-reactkit 3.2.0 → 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
@@ -520,8 +521,9 @@ const genRouteHandler = (
             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
@@ -613,6 +615,7 @@ const genRouteHandler = (
           minute: 1,
           timestamp: Date.now(),
           tags: [],
+          level: LogLevel.Warn,
           metadata: {},
           context: LogBuiltInMetadata.Context.Uncategorized,
           subcontext: LogBuiltInMetadata.Context.Uncategorized,

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
@@ -86,6 +87,7 @@ const initServer = (
    * @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
@@ -101,6 +103,7 @@ const initServer = (
         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
             ? {
               context: params.context,
               subcontext: params.subcontext,
               tags: params.tags,
+              level: params.level,
               metadata: params.metadata,
               error: {
                 message: params.errorMessage,
@@ -128,12 +133,23 @@ const initServer = (
               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
@@ -55,6 +58,8 @@ type LogMainInfo = {
   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/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
@@ -20,6 +21,8 @@ type LogFunction = (
       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;