dce-reactkit 3.2.0 → 3.2.2-beta.1

package/dist/esm/index.js

@@ -491,6 +491,184 @@ class ErrorWithCode extends Error {
     }
 }
 
+/**
+ * Path that all routes start with
+ * @author Gabe Abrams
+ */
+const ROUTE_PATH_PREFIX = '/dce-reactkit';
+
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+const LOG_ROUTE_PATH = `${ROUTE_PATH_PREFIX}/log`;
+
+/**
+ * Built-in metadata for logs
+ * @author Gabe Abrams
+ */
+const LogBuiltInMetadata = {
+    // Contexts
+    Context: {
+        Uncategorized: 'n/a',
+        ServerRenderedErrorPage: '_server-rendered-error-page',
+        ServerEndpointError: '_server-endpoint-error',
+        ClientFatalError: '_client-fatal-error',
+    },
+    // Targets
+    Target: {
+        NoSpecificTarget: 'n/a',
+    },
+};
+
+// Keep track of whether or not session expiry has already been handled
+let sessionAlreadyExpired = false;
+/*------------------------------------------------------------------------*/
+/*                               Stub Logic                               */
+/*------------------------------------------------------------------------*/
+// Stored stub responses
+const stubResponses = {};
+/**
+ * Add a stub response
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param [opts.method=GET] http request method
+ * @param opts.path pathname of the request
+ * @param [opts.body] body of the response if successful
+ * @param [opts.errorMessage] error message if not successful
+ * @param [opts.errorCode] error code if not successful
+ */
+const _setStubResponse = (opts) => {
+    var _a, _b, _c;
+    const { path, body, } = opts;
+    const method = ((_a = opts.method) !== null && _a !== void 0 ? _a : 'GET').toUpperCase();
+    const errorMessage = ((_b = opts.errorMessage) !== null && _b !== void 0 ? _b : 'An unknown error has occurred.');
+    const errorCode = ((_c = opts.errorCode) !== null && _c !== void 0 ? _c : ReactKitErrorCode$1.NoCode);
+    // Store to stub responses
+    if (!stubResponses[method]) {
+        stubResponses[method] = {};
+    }
+    stubResponses[method][path] = ((opts.errorMessage || opts.errorCode)
+        ? {
+            success: false,
+            errorMessage,
+            errorCode,
+        }
+        : {
+            success: true,
+            body: body !== null && body !== void 0 ? body : undefined,
+        });
+};
+/*------------------------------------------------------------------------*/
+/*                                  Main                                  */
+/*------------------------------------------------------------------------*/
+/**
+ * Visit an endpoint on the server [for client only]
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.path - the path of the server endpoint
+ * @param [opts.method=GET] - the method of the endpoint
+ * @param [opts.params] - query/body parameters to include
+ * @returns response from server
+ */
+const visitServerEndpoint = (opts) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    const method = ((_a = opts.method) !== null && _a !== void 0 ? _a : 'GET');
+    // Handle stubs
+    const stubResponse = (_b = stubResponses[method]) === null || _b === void 0 ? void 0 : _b[opts.path];
+    if (stubResponse) {
+        // Remove from list
+        try {
+            stubResponses[method][opts.path] = undefined;
+        }
+        catch (err) {
+            // Ignore
+        }
+        // Success
+        if (stubResponse.success) {
+            return stubResponse.body;
+        }
+        // Error
+        throw new ErrorWithCode(stubResponse.errorMessage, stubResponse.errorCode);
+    }
+    // Send the request
+    const response = yield cacclSendRequest({
+        path: opts.path,
+        method: (_c = opts.method) !== null && _c !== void 0 ? _c : 'GET',
+        params: opts.params,
+    });
+    // Check for failure
+    if (!response || !response.body) {
+        throw new ErrorWithCode('We didn\'t get a response from the server. Please check your internet connection.', ReactKitErrorCode$1.NoResponse);
+    }
+    if (!response.body.success) {
+        // Session expired
+        if (response.body.code === ReactKitErrorCode$1.SessionExpired) {
+            // Skip notice if session was already expired
+            if (sessionAlreadyExpired) {
+                // Never return (browser is already reloading)
+                yield new Promise(() => {
+                    // Promise that never returns
+                });
+            }
+            sessionAlreadyExpired = true;
+            // Show session expiration message
+            {
+                // Fallback to alert
+                // eslint-disable-next-line no-alert
+                alert('Your session has expired. Please start over.');
+            }
+            // Never return (don't continue execution)
+            yield new Promise(() => {
+                // Promise that never returns
+            });
+        }
+        // Other errors
+        throw new ErrorWithCode((response.body.message
+            || 'An unknown error occurred. Please contact an admin.'), (response.body.code
+            || ReactKitErrorCode$1.NoCode));
+    }
+    // Success! Extract the body
+    const { body } = response.body;
+    // Return
+    return body;
+});
+
+/**
+ * Log a user action on the client (cannot be used on the server)
+ * @author Gabe Abrams
+ */
+const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e, _f;
+    return visitServerEndpoint({
+        path: LOG_ROUTE_PATH,
+        method: 'POST',
+        params: {
+            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),
+            errorCode: (opts.error
+                ? opts.error.code
+                : undefined),
+            errorStack: (opts.error
+                ? opts.error.stack
+                : undefined),
+            target: (opts.action
+                ? ((_f = opts.target) !== null && _f !== void 0 ? _f : LogBuiltInMetadata.Target.NoSpecificTarget)
+                : undefined),
+            action: (opts.action
+                ? opts.action
+                : undefined),
+        },
+    });
+});
+
 /**
  * A wrapper for the entire React app that adds global functionality like
  *   handling for fatal error messages, adds bootstrap support
@@ -610,6 +788,14 @@ const showFatalError = (error, errorTitle = 'An Error Occurred') => {
     const code = (typeof error === 'string'
         ? ReactKitErrorCode$1.NoCode
         : String((_b = error.code) !== null && _b !== void 0 ? _b : ReactKitErrorCode$1.NoCode));
+    // Add log
+    logClientEvent({
+        context: LogBuiltInMetadata.Context.ClientFatalError,
+        error,
+        metadata: {
+            errorTitle,
+        },
+    });
     // Handle case where app hasn't loaded
     if (!setFatalErrorMessage || !setFatalErrorCode) {
         alert$1(errorTitle, `${message} (code: ${code}). Please contact support.`);
@@ -2003,131 +2189,6 @@ const roundToNumDecimals = (num, numDecimals) => {
     return (Math.round(num * rounder) / rounder);
 };
 
-// Keep track of whether or not session expiry has already been handled
-let sessionAlreadyExpired = false;
-/*------------------------------------------------------------------------*/
-/*                               Stub Logic                               */
-/*------------------------------------------------------------------------*/
-// Stored stub responses
-const stubResponses = {};
-/**
- * Add a stub response
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param [opts.method=GET] http request method
- * @param opts.path pathname of the request
- * @param [opts.body] body of the response if successful
- * @param [opts.errorMessage] error message if not successful
- * @param [opts.errorCode] error code if not successful
- */
-const _setStubResponse = (opts) => {
-    var _a, _b, _c;
-    const { path, body, } = opts;
-    const method = ((_a = opts.method) !== null && _a !== void 0 ? _a : 'GET').toUpperCase();
-    const errorMessage = ((_b = opts.errorMessage) !== null && _b !== void 0 ? _b : 'An unknown error has occurred.');
-    const errorCode = ((_c = opts.errorCode) !== null && _c !== void 0 ? _c : ReactKitErrorCode$1.NoCode);
-    // Store to stub responses
-    if (!stubResponses[method]) {
-        stubResponses[method] = {};
-    }
-    stubResponses[method][path] = ((opts.errorMessage || opts.errorCode)
-        ? {
-            success: false,
-            errorMessage,
-            errorCode,
-        }
-        : {
-            success: true,
-            body: body !== null && body !== void 0 ? body : undefined,
-        });
-};
-/*------------------------------------------------------------------------*/
-/*                                  Main                                  */
-/*------------------------------------------------------------------------*/
-/**
- * Visit an endpoint on the server [for client only]
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.path - the path of the server endpoint
- * @param [opts.method=GET] - the method of the endpoint
- * @param [opts.params] - query/body parameters to include
- * @returns response from server
- */
-const visitServerEndpoint = (opts) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c;
-    const method = ((_a = opts.method) !== null && _a !== void 0 ? _a : 'GET');
-    // Handle stubs
-    const stubResponse = (_b = stubResponses[method]) === null || _b === void 0 ? void 0 : _b[opts.path];
-    if (stubResponse) {
-        // Remove from list
-        try {
-            stubResponses[method][opts.path] = undefined;
-        }
-        catch (err) {
-            // Ignore
-        }
-        // Success
-        if (stubResponse.success) {
-            return stubResponse.body;
-        }
-        // Error
-        throw new ErrorWithCode(stubResponse.errorMessage, stubResponse.errorCode);
-    }
-    // Send the request
-    const response = yield cacclSendRequest({
-        path: opts.path,
-        method: (_c = opts.method) !== null && _c !== void 0 ? _c : 'GET',
-        params: opts.params,
-    });
-    // Check for failure
-    if (!response || !response.body) {
-        throw new ErrorWithCode('We didn\'t get a response from the server. Please check your internet connection.', ReactKitErrorCode$1.NoResponse);
-    }
-    if (!response.body.success) {
-        // Session expired
-        if (response.body.code === ReactKitErrorCode$1.SessionExpired) {
-            // Skip notice if session was already expired
-            if (sessionAlreadyExpired) {
-                // Never return (browser is already reloading)
-                yield new Promise(() => {
-                    // Promise that never returns
-                });
-            }
-            sessionAlreadyExpired = true;
-            // Show session expiration message
-            {
-                // Fallback to alert
-                // eslint-disable-next-line no-alert
-                alert('Your session has expired. Please start over.');
-            }
-            // Never return (don't continue execution)
-            yield new Promise(() => {
-                // Promise that never returns
-            });
-        }
-        // Other errors
-        throw new ErrorWithCode((response.body.message
-            || 'An unknown error occurred. Please contact an admin.'), (response.body.code
-            || ReactKitErrorCode$1.NoCode));
-    }
-    // Success! Extract the body
-    const { body } = response.body;
-    // Return
-    return body;
-});
-
-/**
- * Path that all routes start with
- * @author Gabe Abrams
- */
-const ROUTE_PATH_PREFIX = '/dce-reactkit';
-
-/**
- * Path of the route for storing client-side logs
- * @author Gabe Abrams
- */
-const LOG_ROUTE_PATH = `${ROUTE_PATH_PREFIX}/log`;
-
 /**
  * Server-side API param types
  * @author Gabe Abrams
@@ -2202,6 +2263,7 @@ const initServer = (opts) => {
      * @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
@@ -2215,6 +2277,7 @@ const initServer = (opts) => {
             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,
@@ -2223,12 +2286,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
                 ? {
                     context: params.context,
                     subcontext: params.subcontext,
                     tags: params.tags,
+                    level: params.level,
                     metadata: params.metadata,
                     error: {
                         message: params.errorMessage,
@@ -2241,10 +2306,16 @@ const initServer = (opts) => {
                     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;
         },
     }));
@@ -2573,23 +2644,6 @@ var LogSource;
 })(LogSource || (LogSource = {}));
 var LogSource$1 = LogSource;
 
-/**
- * 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',
-    },
-};
-
 /**
  * Types of actions
  * @author Gabe Abrams
@@ -2631,6 +2685,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
@@ -2955,7 +3021,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;
+            var _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
             // 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
@@ -2989,21 +3055,22 @@ const genRouteHandler = (opts) => {
                         ? 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 : {},
+                    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)
                     ? {
                         type: LogType$1.Error,
-                        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',
+                        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',
                     }
                     : {
                         type: LogType$1.Action,
-                        target: ((_l = opts.target) !== null && _l !== void 0 ? _l : LogBuiltInMetadata.Target.NoSpecificTarget),
-                        action: ((_m = opts.action) !== null && _m !== void 0 ? _m : LogAction$1.Unknown),
+                        target: ((_m = opts.target) !== null && _m !== void 0 ? _m : LogBuiltInMetadata.Target.NoSpecificTarget),
+                        action: ((_o = opts.action) !== null && _o !== void 0 ? _o : LogAction$1.Unknown),
                     });
                 // Source-specific info
                 const sourceSpecificInfo = (opts.overrideAsClientEvent
@@ -3065,6 +3132,7 @@ const genRouteHandler = (opts) => {
                     minute: 1,
                     timestamp: Date.now(),
                     tags: [],
+                    level: LogLevel$1.Warn,
                     metadata: {},
                     context: LogBuiltInMetadata.Context.Uncategorized,
                     subcontext: LogBuiltInMetadata.Context.Uncategorized,
@@ -3362,41 +3430,6 @@ const parallelLimit = (taskFunctions, limit) => __awaiter(void 0, void 0, void 0
     return results;
 });
 
-/**
- * Log a user action on the client (cannot be used on the server)
- * @author Gabe Abrams
- */
-const logClientEvent = (opts) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c, _d, _e, _f;
-    return visitServerEndpoint({
-        path: LOG_ROUTE_PATH,
-        method: 'POST',
-        params: {
-            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),
-            errorCode: (opts.error
-                ? opts.error.code
-                : undefined),
-            errorStack: (opts.error
-                ? opts.error.stack
-                : undefined),
-            target: (opts.action
-                ? ((_f = opts.target) !== null && _f !== void 0 ? _f : LogBuiltInMetadata.Target.NoSpecificTarget)
-                : undefined),
-            action: (opts.action
-                ? opts.action
-                : undefined),
-        },
-    });
-});
-
 /**
  * Initialize a log collection given the dce-mango Collection class
  * @author Gabe Abrams