dce-reactkit 3.2.0-beta.9 → 3.2.1

package/.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
+    "Subcontext",
     "Uncategorized"
   ]
 }

package/dist/cjs/index.js

@@ -2203,13 +2203,14 @@ const initServer = (opts) => {
     /**
      * 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
@@ -2220,9 +2221,10 @@ const initServer = (opts) => {
      */
     opts.app.post(LOG_ROUTE_PATH, genRouteHandler({
         paramTypes: {
-            category: ParamType$1.String,
-            subcategory: ParamType$1.String,
+            context: ParamType$1.String,
+            subcontext: ParamType$1.String,
             tags: ParamType$1.JSON,
+            level: ParamType$1.String,
             metadata: ParamType$1.JSON,
             errorMessage: ParamType$1.StringOptional,
             errorCode: ParamType$1.StringOptional,
@@ -2231,12 +2233,14 @@ const initServer = (opts) => {
             action: ParamType$1.StringOptional,
         },
         handler: ({ params, logServerEvent }) => {
-            const log = logServerEvent((params.errorMessage || params.errorCode || params.errorStack)
+            // Create log info
+            const logInfo = ((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,
@@ -2246,13 +2250,19 @@ const initServer = (opts) => {
                 }
                 // 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 = Object.assign(Object.assign({}, logInfo), { overrideAsClientEvent: true });
+            // Write the log
+            const log = logServerEvent(logInfoForcedFromClient);
+            // Return
             return log;
         },
     }));
@@ -2582,12 +2592,12 @@ var LogSource;
 var LogSource$1 = LogSource;
 
 /**
- * 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',
@@ -2639,6 +2649,18 @@ var LogAction;
 })(LogAction || (LogAction = {}));
 var LogAction$1 = LogAction;
 
+/**
+ * Allowed log levels
+ * @author Gabe Abrams
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["Warn"] = "Warn";
+    LogLevel["Info"] = "Info";
+    LogLevel["Debug"] = "Debug";
+})(LogLevel || (LogLevel = {}));
+var LogLevel$1 = LogLevel;
+
 /**
  * Generate an express API route handler
  * @author Gabe Abrams
@@ -2993,14 +3015,13 @@ const genRouteHandler = (opts) => {
                     hour,
                     minute,
                     timestamp,
-                    category: (typeof opts.category === 'string'
-                        ? opts.category
-                        : ((_d = ((_c = opts.category) !== null && _c !== void 0 ? _c : {})._) !== null && _d !== void 0 ? _d : LogBuiltInMetadata.Category.Uncategorized)),
-                    subcategory: (typeof opts.category === 'string'
-                        ? opts.subcategory
-                        : ((_f = ((_e = opts.subcategory) !== null && _e !== void 0 ? _e : {})._) !== null && _f !== void 0 ? _f : LogBuiltInMetadata.Category.Uncategorized)),
-                    tags: (_g = opts.tags) !== null && _g !== void 0 ? _g : [],
-                    metadata: (_h = opts.metadata) !== null && _h !== void 0 ? _h : {},
+                    context: (typeof opts.context === 'string'
+                        ? opts.context
+                        : ((_d = ((_c = opts.context) !== null && _c !== void 0 ? _c : {})._) !== null && _d !== void 0 ? _d : LogBuiltInMetadata.Context.Uncategorized)),
+                    subcontext: ((_e = opts.subcontext) !== null && _e !== void 0 ? _e : LogBuiltInMetadata.Context.Uncategorized),
+                    tags: ((_f = opts.tags) !== null && _f !== void 0 ? _f : []),
+                    level: ((_g = opts.level) !== null && _g !== void 0 ? _g : LogLevel$1.Info),
+                    metadata: ((_h = opts.metadata) !== null && _h !== void 0 ? _h : {}),
                 };
                 // Type-specific info
                 const typeSpecificInfo = (('error' in opts && opts.error)
@@ -3075,9 +3096,10 @@ const genRouteHandler = (opts) => {
                     minute: 1,
                     timestamp: Date.now(),
                     tags: [],
+                    level: LogLevel$1.Warn,
                     metadata: {},
-                    category: LogBuiltInMetadata.Category.Uncategorized,
-                    subcategory: LogBuiltInMetadata.Category.Uncategorized,
+                    context: LogBuiltInMetadata.Context.Uncategorized,
+                    subcontext: LogBuiltInMetadata.Context.Uncategorized,
                 };
                 const dummyTypeSpecificInfo = {
                     type: LogType$1.Error,
@@ -3136,7 +3158,7 @@ const genRouteHandler = (opts) => {
             send(html, (_a = opts.status) !== null && _a !== void 0 ? _a : 500);
             // Log
             logServerEvent({
-                category: LogBuiltInMetadata.Category.ServerRenderedErrorPage,
+                context: LogBuiltInMetadata.Context.ServerRenderedErrorPage,
                 error: {
                     message: `${opts.title}: ${opts.description}`,
                     code: opts.code,
@@ -3175,7 +3197,7 @@ const genRouteHandler = (opts) => {
                 handleError(res, err);
                 // Log server-side error
                 logServerEvent({
-                    category: LogBuiltInMetadata.Category.ServerEndpointError,
+                    context: LogBuiltInMetadata.Context.ServerEndpointError,
                     error: err,
                 });
                 return;
@@ -3377,19 +3399,17 @@ const parallelLimit = (taskFunctions, limit) => __awaiter(void 0, void 0, void 0
  * @author Gabe Abrams
  */
 const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f;
     return visitServerEndpoint({
         path: LOG_ROUTE_PATH,
         method: 'POST',
         params: {
-            category: (typeof opts.category === 'string'
-                ? opts.category
-                : ((_b = ((_a = opts.category) !== null && _a !== void 0 ? _a : {})._) !== null && _b !== void 0 ? _b : LogBuiltInMetadata.Category.Uncategorized)),
-            subcategory: (typeof opts.category === 'string'
-                ? opts.subcategory
-                : ((_d = ((_c = opts.subcategory) !== null && _c !== void 0 ? _c : {})._) !== null && _d !== void 0 ? _d : LogBuiltInMetadata.Category.Uncategorized)),
-            tags: JSON.stringify((_e = opts.tags) !== null && _e !== void 0 ? _e : []),
-            metadata: JSON.stringify((_f = opts.metadata) !== null && _f !== void 0 ? _f : {}),
+            context: (typeof opts.context === 'string'
+                ? opts.context
+                : ((_b = ((_a = opts.context) !== null && _a !== void 0 ? _a : {})._) !== null && _b !== void 0 ? _b : LogBuiltInMetadata.Context.Uncategorized)),
+            subcontext: ((_c = opts.subcontext) !== null && _c !== void 0 ? _c : LogBuiltInMetadata.Context.Uncategorized),
+            tags: JSON.stringify((_d = opts.tags) !== null && _d !== void 0 ? _d : []),
+            metadata: JSON.stringify((_e = opts.metadata) !== null && _e !== void 0 ? _e : {}),
             errorMessage: (opts.error
                 ? opts.error.message
                 : undefined),
@@ -3400,7 +3420,7 @@ const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* ()
                 ? opts.error.stack
                 : undefined),
             target: (opts.action
-                ? ((_g = opts.target) !== null && _g !== void 0 ? _g : LogBuiltInMetadata.Target.NoSpecificTarget)
+                ? ((_f = opts.target) !== null && _f !== void 0 ? _f : LogBuiltInMetadata.Target.NoSpecificTarget)
                 : undefined),
             action: (opts.action
                 ? opts.action
@@ -3420,8 +3440,8 @@ const initLogCollection = (Collection) => {
         uniqueIndexKey: 'id',
         indexKeys: [
             'courseId',
-            'category',
-            'subcategory',
+            'context',
+            'subcontext',
             'tags',
         ],
     });
@@ -3456,7 +3476,7 @@ exports.HOUR_IN_MS = HOUR_IN_MS;
 exports.ItemPicker = ItemPicker;
 exports.LoadingSpinner = LoadingSpinner;
 exports.LogAction = LogAction$1;
-exports.LogBuiltInCategory = LogBuiltInMetadata;
+exports.LogBuiltInMetadata = LogBuiltInMetadata;
 exports.LogSource = LogSource$1;
 exports.LogType = LogType$1;
 exports.MINUTE_IN_MS = MINUTE_IN_MS;