dce-reactkit 2.0.3 → 2.0.6

package/lib/components/AppWrapper.d.ts

@@ -0,0 +1,19 @@
+/**
+ * A wrapper for the entire React app that adds global functionality like
+ *   handling for fatal error messages
+ * @author Gabe Abrams
+ */
+import React from 'react';
+declare type Props = {
+    children: React.ReactNode;
+    dark?: boolean;
+    sessionExpiredMessage?: string;
+};
+/**
+ * Show a fatal error message
+ * @author Gabe Abrams
+ * @param error the error to show
+ */
+export declare const showFatalError: (error: any) => void;
+declare const AppWrapper: (props: Props) => React.ReactElement;
+export default AppWrapper;

package/lib/components/AppWrapper.js

@@ -0,0 +1,127 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.showFatalError = void 0;
+var jsx_runtime_1 = require("react/jsx-runtime");
+/**
+ * A wrapper for the entire React app that adds global functionality like
+ *   handling for fatal error messages
+ * @author Gabe Abrams
+ */
+// Import React
+var react_1 = require("react");
+// Import shared components
+var ErrorBox_1 = __importDefault(require("./ErrorBox"));
+// Import helpers
+var visitServerEndpoint_1 = require("../helpers/visitServerEndpoint");
+// Import shared types
+var ReactKitErrorCode_1 = __importDefault(require("../types/ReactKitErrorCode"));
+// Import custom errors
+var ErrorWithCode_1 = __importDefault(require("../errors/ErrorWithCode"));
+/*------------------------------------------------------------------------*/
+/*                             Static Helpers                             */
+/*------------------------------------------------------------------------*/
+// Stored copies of setters
+var setFatalErrorMessage;
+var setFatalErrorCode;
+/**
+ * Show a fatal error message
+ * @author Gabe Abrams
+ * @param error the error to show
+ */
+var showFatalError = function (error) {
+    var _a, _b;
+    // Determine message and code
+    var message = (typeof error === 'string'
+        ? error.trim()
+        : String((_a = error.message) !== null && _a !== void 0 ? _a : 'An unknown error occurred.'));
+    var code = (typeof error === 'string'
+        ? ReactKitErrorCode_1.default.NoCode
+        : String((_b = error.code) !== null && _b !== void 0 ? _b : ReactKitErrorCode_1.default.NoCode));
+    // Handle case where app hasn't loaded
+    if (!setFatalErrorMessage || !setFatalErrorCode) {
+        return alert("An error has occurred: ".concat(message, " (code: ").concat(code, "). Please contact support."));
+    }
+    // Use setters
+    setFatalErrorMessage(message);
+    setFatalErrorCode(code);
+};
+exports.showFatalError = showFatalError;
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+var AppWrapper = function (props) {
+    /*------------------------------------------------------------------------*/
+    /*                                  Setup                                 */
+    /*------------------------------------------------------------------------*/
+    /* -------------- Props ------------- */
+    var children = props.children, dark = props.dark, _a = props.sessionExpiredMessage, sessionExpiredMessage = _a === void 0 ? 'Your session has expired. Please go back to Canvas and start over.' : _a;
+    /* -------------- State ------------- */
+    // Fatal error
+    var _b = (0, react_1.useState)(null), fatalErrorMessage = _b[0], setFatalErrorMessageInner = _b[1];
+    setFatalErrorMessage = setFatalErrorMessageInner;
+    var _c = (0, react_1.useState)(null), fatalErrorCode = _c[0], setFatalErrorCodeInner = _c[1];
+    setFatalErrorCode = setFatalErrorCodeInner;
+    // Session expired
+    var _d = (0, react_1.useState)(false), sessionHasExpired = _d[0], setSessionHasExpired = _d[1];
+    /*------------------------------------------------------------------------*/
+    /*                           Lifecycle Functions                          */
+    /*------------------------------------------------------------------------*/
+    /**
+     * Mount
+     * @author Gabe Abrams
+     */
+    (0, react_1.useEffect)(function () {
+        // Add session expired handler
+        (0, visitServerEndpoint_1.setSessionExpiryHandler)(function () {
+            // Session expired!
+            setSessionHasExpired(true);
+        });
+    }, []);
+    /*------------------------------------------------------------------------*/
+    /*                                 Render                                 */
+    /*------------------------------------------------------------------------*/
+    /*----------------------------------------*/
+    /*                 Main UI                */
+    /*----------------------------------------*/
+    // Show error
+    if (fatalErrorMessage || fatalErrorCode || sessionHasExpired) {
+        // Re-encapsulate in an error
+        var error = (sessionHasExpired
+            ? new ErrorWithCode_1.default(fatalErrorMessage, fatalErrorCode)
+            : new ErrorWithCode_1.default(sessionExpiredMessage, ReactKitErrorCode_1.default.SessionExpired));
+        // Build error screen
+        return ((0, jsx_runtime_1.jsx)("div", __assign({ style: {
+                display: 'block',
+                width: '100vw',
+                minHeight: '100vh',
+                paddingTop: '10rem',
+                backgroundColor: (dark
+                    ? '#222'
+                    : '#fff'),
+            } }, { children: (0, jsx_runtime_1.jsx)(ErrorBox_1.default, { title: (sessionHasExpired
+                    ? 'Session Expired'
+                    : undefined), error: error }) })));
+    }
+    // Show the app itself
+    return ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: children }));
+};
+/*------------------------------------------------------------------------*/
+/*                                 Wrap Up                                */
+/*------------------------------------------------------------------------*/
+// Export component
+exports.default = AppWrapper;
+//# sourceMappingURL=AppWrapper.js.map

package/lib/components/AppWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppWrapper.js","sourceRoot":"","sources":["../../src/components/AppWrapper.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA;;;;GAIG;AAEH,eAAe;AACf,+BAAmD;AAEnD,2BAA2B;AAC3B,wDAAkC;AAElC,iBAAiB;AACjB,sEAAyE;AAEzE,sBAAsB;AACtB,iFAA2D;AAE3D,uBAAuB;AACvB,0EAAoD;AAepD,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,2BAA2B;AAC3B,IAAI,oBAA+C,CAAC;AACpD,IAAI,iBAAyC,CAAC;AAE9C;;;;GAIG;AACI,IAAM,cAAc,GAAG,UAAC,KAAU;;IACvC,6BAA6B;IAC7B,IAAM,OAAO,GAAW,CACtB,OAAO,KAAK,KAAK,QAAQ;QACvB,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE;QACd,CAAC,CAAC,MAAM,CAAC,MAAA,KAAK,CAAC,OAAO,mCAAI,4BAA4B,CAAC,CAC1D,CAAC;IACF,IAAM,IAAI,GAAW,CACnB,OAAO,KAAK,KAAK,QAAQ;QACvB,CAAC,CAAC,2BAAiB,CAAC,MAAM;QAC1B,CAAC,CAAC,MAAM,CAAC,MAAA,KAAK,CAAC,IAAI,mCAAI,2BAAiB,CAAC,MAAM,CAAC,CACnD,CAAC;IAEF,sCAAsC;IACtC,IAAI,CAAC,oBAAoB,IAAI,CAAC,iBAAiB,EAAE;QAC/C,OAAO,KAAK,CAAC,iCAA0B,OAAO,qBAAW,IAAI,+BAA4B,CAAC,CAAC;KAC5F;IAED,cAAc;IACd,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC9B,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC,CAAC;AArBW,QAAA,cAAc,kBAqBzB;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,IAAM,UAAU,GAAG,UAAC,KAAY;IAC9B,4EAA4E;IAC5E,4EAA4E;IAC5E,4EAA4E;IAE5E,wCAAwC;IAGtC,IAAA,QAAQ,GAGN,KAAK,SAHC,EACR,IAAI,GAEF,KAAK,KAFH,EACJ,KACE,KAAK,sBADqF,EAA5F,qBAAqB,mBAAG,oEAAoE,KAAA,CACpF;IAEV,wCAAwC;IAExC,cAAc;IACR,IAAA,KAAiD,IAAA,gBAAQ,EAAC,IAAI,CAAC,EAA9D,iBAAiB,QAAA,EAAE,yBAAyB,QAAkB,CAAC;IACtE,oBAAoB,GAAG,yBAAyB,CAAC;IAC3C,IAAA,KAA2C,IAAA,gBAAQ,EAAC,IAAI,CAAC,EAAxD,cAAc,QAAA,EAAE,sBAAsB,QAAkB,CAAC;IAChE,iBAAiB,GAAG,sBAAsB,CAAC;IAE3C,kBAAkB;IACZ,IAAA,KAA4C,IAAA,gBAAQ,EAAC,KAAK,CAAC,EAA1D,iBAAiB,QAAA,EAAE,oBAAoB,QAAmB,CAAC;IAElE,4EAA4E;IAC5E,4EAA4E;IAC5E,4EAA4E;IAE5E;;;OAGG;IACH,IAAA,iBAAS,EACP;QACE,8BAA8B;QAC9B,IAAA,6CAAuB,EAAC;YACtB,mBAAmB;YACnB,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC,EACD,EAAE,CACH,CAAC;IAEF,4EAA4E;IAC5E,4EAA4E;IAC5E,4EAA4E;IAE5E,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAE5C,aAAa;IACb,IAAI,iBAAiB,IAAI,cAAc,IAAI,iBAAiB,EAAE;QAC5D,6BAA6B;QAC7B,IAAM,KAAK,GAAG,CACZ,iBAAiB;YACf,CAAC,CAAC,IAAI,uBAAa,CACjB,iBAAiB,EACjB,cAAc,CACf;YACD,CAAC,CAAC,IAAI,uBAAa,CACjB,qBAAqB,EACrB,2BAAiB,CAAC,cAAc,CACjC,CACJ,CAAC;QAEF,qBAAqB;QACrB,OAAO,CACL,yCACE,KAAK,EAAE;gBACL,OAAO,EAAE,OAAO;gBAChB,KAAK,EAAE,OAAO;gBACd,SAAS,EAAE,OAAO;gBAClB,UAAU,EAAE,OAAO;gBACnB,eAAe,EAAE,CACf,IAAI;oBACF,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,MAAM,CACX;aACF,gBAED,uBAAC,kBAAQ,IACP,KAAK,EAAE,CACL,iBAAiB;oBACf,CAAC,CAAC,iBAAiB;oBACnB,CAAC,CAAC,SAAS,CACd,EACD,KAAK,EAAE,KAAK,GACZ,IACE,CACP,CAAC;KACH;IAED,sBAAsB;IACtB,OAAO,CACL,2DACG,QAAQ,GACR,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,mBAAmB;AACnB,kBAAe,UAAU,CAAC"}

package/{src → lib}/components/AppWrapper.tsx

@@ -5,11 +5,14 @@
  */
 
 // Import React
-import React, { useState } from 'react';
+import React, { useState, useEffect } from 'react';
 
 // Import shared components
 import ErrorBox from './ErrorBox';
 
+// Import helpers
+import { setSessionExpiryHandler } from '../helpers/visitServerEndpoint';
+
 // Import shared types
 import ReactKitErrorCode from '../types/ReactKitErrorCode';
 
@@ -25,6 +28,8 @@ type Props = {
   children: React.ReactNode,
   // True if this app is a dark-themed app
   dark?: boolean,
+  // Custom session expired message
+  sessionExpiredMessage?: string,
 };
 
 /*------------------------------------------------------------------------*/
@@ -67,7 +72,7 @@ export const showFatalError = (error: any) => {
 /*                                Component                               */
 /*------------------------------------------------------------------------*/
 
-const AppWrapper = (props: Props) => {
+const AppWrapper = (props: Props): React.ReactElement => {
   /*------------------------------------------------------------------------*/
   /*                                  Setup                                 */
   /*------------------------------------------------------------------------*/
@@ -77,6 +82,7 @@ const AppWrapper = (props: Props) => {
   const {
     children,
     dark,
+    sessionExpiredMessage = 'Your session has expired. Please go back to Canvas and start over.',
   } = props;
 
   /* -------------- State ------------- */
@@ -87,18 +93,52 @@ const AppWrapper = (props: Props) => {
   const [fatalErrorCode, setFatalErrorCodeInner] = useState(null);
   setFatalErrorCode = setFatalErrorCodeInner;
 
+  // Session expired
+  const [sessionHasExpired, setSessionHasExpired] = useState(false);
+
+  /*------------------------------------------------------------------------*/
+  /*                           Lifecycle Functions                          */
+  /*------------------------------------------------------------------------*/
+
+  /**
+   * Mount
+   * @author Gabe Abrams
+   */
+  useEffect(
+    () => {
+      // Add session expired handler
+      setSessionExpiryHandler(() => {
+        // Session expired!
+        setSessionHasExpired(true);
+      });
+    },
+    [],
+  );
+
+  /*------------------------------------------------------------------------*/
+  /*                                 Render                                 */
+  /*------------------------------------------------------------------------*/
+
   /*----------------------------------------*/
   /*                 Main UI                */
   /*----------------------------------------*/
 
   // Show error
-  if (fatalErrorMessage || fatalErrorCode) {
+  if (fatalErrorMessage || fatalErrorCode || sessionHasExpired) {
     // Re-encapsulate in an error
-    const error = new ErrorWithCode(
-      fatalErrorMessage,
-      fatalErrorCode,
+    const error = (
+      sessionHasExpired
+        ? new ErrorWithCode(
+          fatalErrorMessage,
+          fatalErrorCode,
+        )
+        : new ErrorWithCode(
+          sessionExpiredMessage,
+          ReactKitErrorCode.SessionExpired,
+        )
     );
 
+    // Build error screen
     return (
       <div
         style={{
@@ -106,9 +146,19 @@ const AppWrapper = (props: Props) => {
           width: '100vw',
           minHeight: '100vh',
           paddingTop: '10rem',
+          backgroundColor: (
+            dark
+              ? '#222'
+              : '#fff'
+          ),
         }}
       >
         <ErrorBox
+          title={(
+            sessionHasExpired
+              ? 'Session Expired'
+              : undefined
+          )}
           error={error}
         />
       </div>
@@ -116,7 +166,11 @@ const AppWrapper = (props: Props) => {
   }
 
   // Show the app itself
-  return children;
+  return (
+    <>
+      {children}
+    </>
+  );
 };
 
 /*------------------------------------------------------------------------*/

package/lib/components/ErrorBox.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Displays an error
+ * @author Gabe Abrams
+ */
+import React from 'react';
+declare type Props = {
+    error: any;
+    title?: string;
+    onClose?: () => void;
+};
+declare const ErrorBox: React.FC<Props>;
+export default ErrorBox;

package/lib/components/ErrorBox.js

@@ -0,0 +1,65 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var jsx_runtime_1 = require("react/jsx-runtime");
+// Import FontAwesome Icons
+var react_fontawesome_1 = require("@fortawesome/react-fontawesome");
+var free_solid_svg_icons_1 = require("@fortawesome/free-solid-svg-icons");
+// Import shared types
+var ReactKitErrorCode_1 = __importDefault(require("../types/ReactKitErrorCode"));
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+var ErrorBox = function (props) {
+    /*------------------------------------------------------------------------*/
+    /*                                  Setup                                 */
+    /*------------------------------------------------------------------------*/
+    var _a;
+    /* -------------- Props ------------- */
+    var error = props.error, _b = props.title, title = _b === void 0 ? 'An Error Occurred' : _b, onClose = props.onClose;
+    /*------------------------------------------------------------------------*/
+    /*                                 Render                                 */
+    /*------------------------------------------------------------------------*/
+    // Determine error text
+    var errorText = (typeof error === 'string'
+        ? error.trim()
+        : String(error.message || 'An unknown error occurred. Please contact support.'));
+    // Error code box
+    var errorCodeBox;
+    if (error && error.code) {
+        errorCodeBox = ((0, jsx_runtime_1.jsxs)("span", { children: [' ', (0, jsx_runtime_1.jsxs)("span", __assign({ style: {
+                        backgroundColor: 'white',
+                        borderRadius: '5px',
+                        paddingLeft: '3px',
+                        paddingRight: '3px',
+                        color: '#DC4150',
+                        fontVariant: 'small-caps',
+                        fontSize: '80%',
+                        whiteSpace: 'nowrap',
+                    } }, { children: ["code:", ' ', String((_a = error.code) !== null && _a !== void 0 ? _a : ReactKitErrorCode_1.default.NoCode).toUpperCase()] }))] }));
+    }
+    // Main UI
+    return ((0, jsx_runtime_1.jsxs)("div", __assign({ className: "alert alert-danger text-center", style: {
+            maxWidth: '650px',
+            margin: 'auto',
+        } }, { children: [(0, jsx_runtime_1.jsxs)("h4", __assign({ className: "mb-1" }, { children: [(0, jsx_runtime_1.jsx)(react_fontawesome_1.FontAwesomeIcon, { icon: free_solid_svg_icons_1.faExclamationTriangle, className: "me-2" }), title] })), (0, jsx_runtime_1.jsxs)("div", { children: [errorText, errorCodeBox] }), onClose && ((0, jsx_runtime_1.jsx)("div", __assign({ className: "mt-2" }, { children: (0, jsx_runtime_1.jsx)("button", __assign({ type: "button", className: "btn btn-light", "aria-label": "dismiss error and close this activity or view", onClick: onClose }, { children: "Close" })) })))] })));
+};
+/*------------------------------------------------------------------------*/
+/*                                 Wrap Up                                */
+/*------------------------------------------------------------------------*/
+// Export component
+exports.default = ErrorBox;
+//# sourceMappingURL=ErrorBox.js.map

package/lib/components/ErrorBox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorBox.js","sourceRoot":"","sources":["../../src/components/ErrorBox.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAQA,2BAA2B;AAC3B,oEAAiE;AACjE,0EAA0E;AAE1E,sBAAsB;AACtB,iFAA2D;AAe3D,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,IAAM,QAAQ,GAAoB,UAAC,KAAK;IACtC,4EAA4E;IAC5E,4EAA4E;IAC5E,4EAA4E;;IAE5E,wCAAwC;IAGtC,IAAA,KAAK,GAGH,KAAK,MAHF,EACL,KAEE,KAAK,MAFoB,EAA3B,KAAK,mBAAG,mBAAmB,KAAA,EAC3B,OAAO,GACL,KAAK,QADA,CACC;IAEV,4EAA4E;IAC5E,4EAA4E;IAC5E,4EAA4E;IAE5E,uBAAuB;IACvB,IAAM,SAAS,GAAW,CACxB,OAAO,KAAK,KAAK,QAAQ;QACvB,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE;QACd,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,oDAAoD,CAAC,CAClF,CAAC;IAEF,iBAAiB;IACjB,IAAI,YAAY,CAAC;IACjB,IAAI,KAAK,IAAK,KAAa,CAAC,IAAI,EAAE;QAChC,YAAY,GAAG,CACb,6CACG,GAAG,EACJ,2CACE,KAAK,EAAE;wBACL,eAAe,EAAE,OAAO;wBACxB,YAAY,EAAE,KAAK;wBACnB,WAAW,EAAE,KAAK;wBAClB,YAAY,EAAE,KAAK;wBACnB,KAAK,EAAE,SAAS;wBAChB,WAAW,EAAE,YAAY;wBACzB,QAAQ,EAAE,KAAK;wBACf,UAAU,EAAE,QAAQ;qBACrB,0BAGA,GAAG,EACH,MAAM,CAAC,MAAC,KAAa,CAAC,IAAI,mCAAI,2BAAiB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,KACjE,IACF,CACR,CAAC;KACH;IAED,UAAU;IACV,OAAO,CACL,0CACE,SAAS,EAAC,gCAAgC,EAC1C,KAAK,EAAE;YACL,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,MAAM;SACf,iBAED,yCAAI,SAAS,EAAC,MAAM,iBAClB,uBAAC,mCAAe,IACd,IAAI,EAAE,4CAAqB,EAC3B,SAAS,EAAC,MAAM,GAChB,EACD,KAAK,KACH,EACL,4CACG,SAAS,EACT,YAAY,IACT,EACL,OAAO,IAAI,CACV,yCAAK,SAAS,EAAC,MAAM,gBACnB,4CACE,IAAI,EAAC,QAAQ,EACb,SAAS,EAAC,eAAe,gBACd,+CAA+C,EAC1D,OAAO,EAAE,OAAO,2BAGT,IACL,CACP,KACG,CACP,CAAC;AACJ,CAAC,CAAC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,mBAAmB;AACnB,kBAAe,QAAQ,CAAC"}

package/{src → lib}/components/ErrorBox.tsx

@@ -20,6 +20,8 @@ import ReactKitErrorCode from '../types/ReactKitErrorCode';
 type Props = {
   // Error to display
   error: any,
+  // Customized title of error box
+  title?: string,
   // Handler for close,
   onClose?: () => void,
 };
@@ -37,6 +39,7 @@ const ErrorBox: React.FC<Props> = (props) => {
 
   const {
     error,
+    title = 'An Error Occurred',
     onClose,
   } = props;
 
@@ -91,7 +94,7 @@ const ErrorBox: React.FC<Props> = (props) => {
           icon={faExclamationTriangle}
           className="me-2"
         />
-        An Error Occurred
+        {title}
       </h4>
       <div>
         {errorText}

package/lib/helpers/handleError.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Handle an error and respond to the client
+ * @author Gabe Abrams
+ * @param res express response
+ * @param error error info
+ * @param opts.err the error to send to the client
+ *   or the error message
+ * @param [opts.code] an error code (only used if err.code is not
+ *   included)
+ * @param [opts.status=500] the https status code to use
+ *   defined)
+ */
+declare const handleError: (res: any, error: any) => undefined;
+export default handleError;

package/lib/helpers/handleError.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import shared types
+var ReactKitErrorCode_1 = __importDefault(require("../types/ReactKitErrorCode"));
+/**
+ * Handle an error and respond to the client
+ * @author Gabe Abrams
+ * @param res express response
+ * @param error error info
+ * @param opts.err the error to send to the client
+ *   or the error message
+ * @param [opts.code] an error code (only used if err.code is not
+ *   included)
+ * @param [opts.status=500] the https status code to use
+ *   defined)
+ */
+var handleError = function (res, error) {
+    // Get the error message
+    var message;
+    if (error && error.message) {
+        message = (error.message || 'An unknown error occurred.');
+    }
+    else if (typeof error === 'string') {
+        message = (error.trim().length > 0
+            ? error
+            : 'An unknown error occurred.');
+    }
+    else {
+        message = 'An unknown error occurred.';
+    }
+    // Get the error code
+    var code = (error.code || ReactKitErrorCode_1.default.NoCode);
+    // Get the status code
+    var status = (error.status || 500);
+    // Respond to user
+    res
+        // Set the http status code
+        .status(status)
+        // Send a JSON response
+        .json({
+        // Error message
+        message: message,
+        // Error code
+        code: code,
+        // Success = false flag so client can detect server-side errors
+        success: false,
+    });
+    return undefined;
+};
+exports.default = handleError;
+//# sourceMappingURL=handleError.js.map

package/lib/helpers/handleError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleError.js","sourceRoot":"","sources":["../../src/helpers/handleError.ts"],"names":[],"mappings":";;;;;AAAA,sBAAsB;AACtB,iFAA2D;AAE3D;;;;;;;;;;;GAWG;AACH,IAAM,WAAW,GAAG,UAClB,GAAQ,EACR,KASC;IAED,wBAAwB;IACxB,IAAI,OAAO,CAAC;IACZ,IAAI,KAAK,IAAK,KAAa,CAAC,OAAO,EAAE;QACnC,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,4BAA4B,CAAC,CAAC;KAC3D;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACpC,OAAO,GAAG,CACR,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC;YACrB,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,4BAA4B,CACjC,CAAC;KACH;SAAM;QACL,OAAO,GAAG,4BAA4B,CAAC;KACxC;IAED,qBAAqB;IACrB,IAAM,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,2BAAiB,CAAC,MAAM,CAAC,CAAC;IAEtD,sBAAsB;IACtB,IAAM,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC;IAErC,kBAAkB;IAClB,GAAG;QACD,2BAA2B;SAC1B,MAAM,CAAC,MAAM,CAAC;QACf,uBAAuB;SACtB,IAAI,CAAC;QACJ,gBAAgB;QAChB,OAAO,SAAA;QACP,aAAa;QACb,IAAI,MAAA;QACJ,+DAA+D;QAC/D,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IACL,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,kBAAe,WAAW,CAAC"}

package/lib/helpers/handleError.ts

@@ -0,0 +1,65 @@
+// Import shared types
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
+/**
+ * Handle an error and respond to the client
+ * @author Gabe Abrams
+ * @param res express response
+ * @param error error info
+ * @param opts.err the error to send to the client
+ *   or the error message
+ * @param [opts.code] an error code (only used if err.code is not
+ *   included)
+ * @param [opts.status=500] the https status code to use
+ *   defined)
+ */
+const handleError = (
+  res: any,
+  error: (
+    | {
+      message: any,
+      code?: string,
+      status?: number,
+    }
+    | Error
+    | string
+    | any
+  ),
+): undefined => {
+  // Get the error message
+  let message;
+  if (error && (error as any).message) {
+    message = (error.message || 'An unknown error occurred.');
+  } else if (typeof error === 'string') {
+    message = (
+      error.trim().length > 0
+        ? error
+        : 'An unknown error occurred.'
+    );
+  } else {
+    message = 'An unknown error occurred.';
+  }
+
+  // Get the error code
+  const code = (error.code || ReactKitErrorCode.NoCode);
+
+  // Get the status code
+  const status = (error.status || 500);
+
+  // Respond to user
+  res
+    // Set the http status code
+    .status(status)
+    // Send a JSON response
+    .json({
+      // Error message
+      message,
+      // Error code
+      code,
+      // Success = false flag so client can detect server-side errors
+      success: false,
+    });
+  return undefined;
+};
+
+export default handleError;

package/lib/helpers/handleSuccess.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Send successful API response
+ * @author Gabe Abrams
+ * @param res express response
+ * @param body the body of the response to send to the client
+ */
+declare const handleSuccess: (res: any, body: any) => undefined;
+export default handleSuccess;

package/lib/helpers/handleSuccess.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Send successful API response
+ * @author Gabe Abrams
+ * @param res express response
+ * @param body the body of the response to send to the client
+ */
+var handleSuccess = function (res, body) {
+    // Send a http 200 json response
+    res.json({
+        // Include the body as a parameter
+        body: body,
+        // Success = true flag so client can detect successful responses
+        success: true,
+    });
+    return undefined;
+};
+exports.default = handleSuccess;
+//# sourceMappingURL=handleSuccess.js.map

package/lib/helpers/handleSuccess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleSuccess.js","sourceRoot":"","sources":["../../src/helpers/handleSuccess.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,IAAM,aAAa,GAAG,UAAC,GAAQ,EAAE,IAAS;IACxC,gCAAgC;IAChC,GAAG,CAAC,IAAI,CAAC;QACP,kCAAkC;QAClC,IAAI,MAAA;QACJ,gEAAgE;QAChE,OAAO,EAAE,IAAI;KACd,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,kBAAe,aAAa,CAAC"}

package/lib/helpers/handleSuccess.ts

@@ -0,0 +1,18 @@
+/**
+ * Send successful API response
+ * @author Gabe Abrams
+ * @param res express response
+ * @param body the body of the response to send to the client
+ */
+const handleSuccess = (res: any, body: any): undefined => {
+  // Send a http 200 json response
+  res.json({
+    // Include the body as a parameter
+    body,
+    // Success = true flag so client can detect successful responses
+    success: true,
+  });
+  return undefined;
+};
+
+export default handleSuccess;

package/lib/helpers/parseRequest.d.ts

@@ -0,0 +1,21 @@
+import ParamType from '../types/ParamType';
+/**
+ * Parse express request params and body
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.req express request instance
+ * @param opts.res express response instance
+ * @param opts.params map of parameters that should be parsed out of the request
+ * @returns parsed params + user info from session (if it exists) or undefined
+ *   if an error occurred
+ */
+declare const parseRequest: (opts: {
+    req: any;
+    res: any;
+    params: {
+        [x: string]: ParamType;
+    };
+}) => {
+    [x: string]: any;
+};
+export default parseRequest;