dce-reactkit 3.2.0-beta.8 → 3.2.0

package/.vscode/settings.json

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

package/dist/cjs/index.js

@@ -2203,10 +2203,10 @@ 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
@@ -2220,8 +2220,8 @@ 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,
             metadata: ParamType$1.JSON,
             errorMessage: ParamType$1.StringOptional,
@@ -2234,8 +2234,8 @@ const initServer = (opts) => {
             const log = logServerEvent((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: {
@@ -2246,8 +2246,8 @@ const initServer = (opts) => {
                 }
                 // Action
                 : {
-                    category: params.category,
-                    subcategory: params.subcategory,
+                    context: params.context,
+                    subcontext: params.subcontext,
                     tags: params.tags,
                     metadata: params.metadata,
                     target: params.target,
@@ -2582,16 +2582,62 @@ var LogSource;
 var LogSource$1 = LogSource;
 
 /**
- * Built-in categories for logs
+ * Built-in metadata for logs
  * @author Gabe Abrams
  */
-var LogBuiltInCategory;
-(function (LogBuiltInCategory) {
-    LogBuiltInCategory["Uncategorized"] = "n/a";
-    LogBuiltInCategory["ServerRenderedErrorPage"] = "_server-rendered-error-page";
-    LogBuiltInCategory["ServerEndpointError"] = "_server-endpoint-error";
-})(LogBuiltInCategory || (LogBuiltInCategory = {}));
-var LogBuiltInCategory$1 = LogBuiltInCategory;
+const LogBuiltInMetadata = {
+    // Contexts
+    Context: {
+        Uncategorized: 'n/a',
+        ServerRenderedErrorPage: '_server-rendered-error-page',
+        ServerEndpointError: '_server-endpoint-error',
+    },
+    // Targets
+    Target: {
+        NoSpecificTarget: 'n/a',
+    },
+};
+
+/**
+ * Types of actions
+ * @author Gabe Abrams
+ */
+var LogAction;
+(function (LogAction) {
+    // Target was opened by the user (it was not on screen, but now it is)
+    LogAction["Open"] = "open";
+    // Target was closed by the user (it was on screen, but now it is not)
+    LogAction["Close"] = "close";
+    // Target was cancelled by the user (it was on closed without saving)
+    LogAction["Cancel"] = "cancel";
+    // Target was expanded by the user (it always remains on screen, but size was changed)
+    LogAction["Expand"] = "expand";
+    // Target was collapsed by the user (it always remains on screen, but size was changed)
+    LogAction["Collapse"] = "collapse";
+    // Target was viewed by the user (only for items that are not opened or closed, those must use Open/Close actions)
+    LogAction["View"] = "view";
+    // Target interrupted the user (popup, dialog, validation message, etc. appeared without user prompting)
+    LogAction["Interrupt"] = "interrupt";
+    // Target was created by the user (it did not exist before)
+    LogAction["Create"] = "create";
+    // Target was edited by the user (it existed and was changed)
+    LogAction["Edit"] = "edit";
+    // Target was deleted by the user (it existed and now it doesn't)
+    LogAction["Delete"] = "delete";
+    // Target was added by the user (it already existed and was added to another place)
+    LogAction["Add"] = "add";
+    // Target was removed by the user (it was removed from something but still exists)
+    LogAction["Remove"] = "remove";
+    // Target was activated by the user (click, check, tap, keypress, etc.)
+    LogAction["Activate"] = "activate";
+    // Target was deactivated by the user (click away, uncheck, tap outside of, tab away, etc.)
+    LogAction["Deactivate"] = "deactivate";
+    // User showed interest in a target (hover, peek, etc.)
+    LogAction["Peek"] = "peek";
+    // Unknown action
+    LogAction["Unknown"] = "unknown";
+})(LogAction || (LogAction = {}));
+var LogAction$1 = LogAction;
 
 /**
  * Generate an express API route handler
@@ -2917,7 +2963,7 @@ const genRouteHandler = (opts) => {
          * @author Gabe Abrams
          */
         const logServerEvent = (opts) => __awaiter(void 0, void 0, void 0, function* () {
-            var _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+            var _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
             // NOTE: internally, we slip through an opts.overrideAsClientEvent boolean
             // that indicates that this is actually a client event, but we don't
             // include that in the LogFunction type because this is internal and
@@ -2947,27 +2993,25 @@ 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 : LogBuiltInCategory$1.Uncategorized)),
-                    subcategory: (typeof opts.category === 'string'
-                        ? opts.subcategory
-                        : ((_f = ((_e = opts.subcategory) !== null && _e !== void 0 ? _e : {})._) !== null && _f !== void 0 ? _f : LogBuiltInCategory$1.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 : [],
+                    metadata: (_g = opts.metadata) !== null && _g !== void 0 ? _g : {},
                 };
                 // Type-specific info
                 const typeSpecificInfo = (('error' in opts && opts.error)
                     ? {
                         type: LogType$1.Error,
-                        errorMessage: (_j = opts.error.message) !== null && _j !== void 0 ? _j : 'Unknown message',
-                        errorCode: (_k = opts.error.code) !== null && _k !== void 0 ? _k : ReactKitErrorCode$1.NoCode,
-                        errorStack: (_l = opts.error.stack) !== null && _l !== void 0 ? _l : 'No stack',
+                        errorMessage: (_h = opts.error.message) !== null && _h !== void 0 ? _h : 'Unknown message',
+                        errorCode: (_j = opts.error.code) !== null && _j !== void 0 ? _j : ReactKitErrorCode$1.NoCode,
+                        errorStack: (_k = opts.error.stack) !== null && _k !== void 0 ? _k : 'No stack',
                     }
                     : {
                         type: LogType$1.Action,
-                        target: (_m = opts.target) !== null && _m !== void 0 ? _m : 'Unknown',
-                        action: (_o = opts.action) !== null && _o !== void 0 ? _o : 'Unknown'
+                        target: ((_l = opts.target) !== null && _l !== void 0 ? _l : LogBuiltInMetadata.Target.NoSpecificTarget),
+                        action: ((_m = opts.action) !== null && _m !== void 0 ? _m : LogAction$1.Unknown),
                     });
                 // Source-specific info
                 const sourceSpecificInfo = (opts.overrideAsClientEvent
@@ -3030,8 +3074,8 @@ const genRouteHandler = (opts) => {
                     timestamp: Date.now(),
                     tags: [],
                     metadata: {},
-                    category: LogBuiltInCategory$1.Uncategorized,
-                    subcategory: LogBuiltInCategory$1.Uncategorized,
+                    context: LogBuiltInMetadata.Context.Uncategorized,
+                    subcontext: LogBuiltInMetadata.Context.Uncategorized,
                 };
                 const dummyTypeSpecificInfo = {
                     type: LogType$1.Error,
@@ -3090,7 +3134,7 @@ const genRouteHandler = (opts) => {
             send(html, (_a = opts.status) !== null && _a !== void 0 ? _a : 500);
             // Log
             logServerEvent({
-                category: LogBuiltInCategory$1.ServerRenderedErrorPage,
+                context: LogBuiltInMetadata.Context.ServerRenderedErrorPage,
                 error: {
                     message: `${opts.title}: ${opts.description}`,
                     code: opts.code,
@@ -3129,7 +3173,7 @@ const genRouteHandler = (opts) => {
                 handleError(res, err);
                 // Log server-side error
                 logServerEvent({
-                    category: LogBuiltInCategory$1.ServerEndpointError,
+                    context: LogBuiltInMetadata.Context.ServerEndpointError,
                     error: err,
                 });
                 return;
@@ -3336,14 +3380,12 @@ const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* ()
         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 : LogBuiltInCategory$1.Uncategorized)),
-            subcategory: (typeof opts.category === 'string'
-                ? opts.subcategory
-                : ((_d = ((_c = opts.subcategory) !== null && _c !== void 0 ? _c : {})._) !== null && _d !== void 0 ? _d : LogBuiltInCategory$1.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),
@@ -3353,8 +3395,8 @@ const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* ()
             errorStack: (opts.error
                 ? opts.error.stack
                 : undefined),
-            target: (opts.target
-                ? opts.target
+            target: (opts.action
+                ? ((_f = opts.target) !== null && _f !== void 0 ? _f : LogBuiltInMetadata.Target.NoSpecificTarget)
                 : undefined),
             action: (opts.action
                 ? opts.action
@@ -3374,8 +3416,8 @@ const initLogCollection = (Collection) => {
         uniqueIndexKey: 'id',
         indexKeys: [
             'courseId',
-            'category',
-            'subcategory',
+            'context',
+            'subcontext',
             'tags',
         ],
     });
@@ -3397,47 +3439,6 @@ var DayOfWeek;
 })(DayOfWeek || (DayOfWeek = {}));
 var DayOfWeek$1 = DayOfWeek;
 
-/**
- * Types of actions
- * @author Gabe Abrams
- */
-var LogAction;
-(function (LogAction) {
-    // Target was opened by the user (it was not on screen, but now it is)
-    LogAction["Open"] = "open";
-    // Target was closed by the user (it was on screen, but now it is not)
-    LogAction["Close"] = "close";
-    // Target was cancelled by the user (it was on closed without saving)
-    LogAction["Cancel"] = "cancel";
-    // Target was expanded by the user (it always remains on screen, but size was changed)
-    LogAction["Expand"] = "expand";
-    // Target was collapsed by the user (it always remains on screen, but size was changed)
-    LogAction["Collapse"] = "collapse";
-    // Target was viewed by the user (only for items that are not opened or closed, those must use Open/Close actions)
-    LogAction["View"] = "view";
-    // Target interrupted the user (popup, dialog, validation message, etc. appeared without user prompting)
-    LogAction["Interrupt"] = "interrupt";
-    // Target was created by the user (it did not exist before)
-    LogAction["Create"] = "create";
-    // Target was edited by the user (it existed and was changed)
-    LogAction["Edit"] = "edit";
-    // Target was deleted by the user (it existed and now it doesn't)
-    LogAction["Delete"] = "delete";
-    // Target was added by the user (it already existed and was added to another place)
-    LogAction["Add"] = "add";
-    // Target was removed by the user (it was removed from something but still exists)
-    LogAction["Remove"] = "remove";
-    // Target was activated by the user (click, check, tap, keypress, etc.)
-    LogAction["Activate"] = "activate";
-    // Target was deactivated by the user (click away, uncheck, tap outside of, tab away, etc.)
-    LogAction["Deactivate"] = "deactivate";
-    // User showed interest in a target (hover, peek, etc.)
-    LogAction["Peek"] = "peek";
-    // Unknown action
-    LogAction["Unknown"] = "unknown";
-})(LogAction || (LogAction = {}));
-var LogAction$1 = LogAction;
-
 exports.AppWrapper = AppWrapper;
 exports.ButtonInputGroup = ButtonInputGroup;
 exports.CheckboxButton = CheckboxButton;
@@ -3451,7 +3452,7 @@ exports.HOUR_IN_MS = HOUR_IN_MS;
 exports.ItemPicker = ItemPicker;
 exports.LoadingSpinner = LoadingSpinner;
 exports.LogAction = LogAction$1;
-exports.LogBuiltInCategory = LogBuiltInCategory$1;
+exports.LogBuiltInMetadata = LogBuiltInMetadata;
 exports.LogSource = LogSource$1;
 exports.LogType = LogType$1;
 exports.MINUTE_IN_MS = MINUTE_IN_MS;