dce-reactkit 2.0.1 → 2.0.4

package/lib/helpers/parseRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseRequest.js","sourceRoot":"","sources":["../../src/helpers/parseRequest.ts"],"names":[],"mappings":";;;;;AAAA,oBAAoB;AACpB,uCAA0C;AAE1C,sBAAsB;AACtB,iFAA2D;AAC3D,iEAA2C;AAE3C,iBAAiB;AACjB,8DAAwC;AAExC;;;;;;;;;GASG;AACH,IAAM,YAAY,GAAG,UACnB,IAMC;IAED,SAAS;IAET,IAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAE5C,2BAA2B;IAC3B,IAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACnC,IAAA,KAAe,SAAS,CAAC,CAAC,CAAC,EAA1B,MAAI,QAAA,EAAE,IAAI,QAAgB,CAAC;QAElC,6BAA6B;QAC7B,IAAM,KAAK,GAAG,CACZ,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAI,CAAC;eAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAI,CAAC;eACpB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAI,CAAC,CACvB,CAAC;QAEF,QAAQ;QACR,IAAI,IAAI,KAAK,mBAAS,CAAC,OAAO,IAAI,IAAI,KAAK,mBAAS,CAAC,eAAe,EAAE;YACpE,UAAU;YAEV,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,eAAe,EAAE;oBACtC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM;gBACL,eAAe;gBAEf,iBAAiB;gBACjB,IAAM,SAAS,GAAG,CAChB,MAAM,CAAC,KAAK,CAAC;qBACV,IAAI,EAAE;qBACN,WAAW,EAAE,CACjB,CAAC;gBAEF,QAAQ;gBACR,MAAM,CAAC,MAAI,CAAC,GAAG,CACb;oBACE,MAAM;oBACN,KAAK;oBACL,GAAG;oBACH,GAAG;oBACH,GAAG;iBACJ,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAC1B,CAAC;aACH;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,KAAK,IAAI,IAAI,KAAK,mBAAS,CAAC,aAAa,EAAE;YACvE,QAAQ;YAER,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,aAAa,EAAE;oBACpC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBAC1D,oBAAoB;gBACpB,MAAM,CAAC,MAAI,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD;iBAAM;gBACL,SAAS;gBACT,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;oBACE,OAAO,EAAE,sCAA+B,MAAI,4BAAyB;oBACrE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;oBACxC,MAAM,EAAE,GAAG;iBACZ,CACF,CAAC;aACH;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,GAAG,IAAI,IAAI,KAAK,mBAAS,CAAC,WAAW,EAAE;YACnE,MAAM;YAEN,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,WAAW,EAAE;oBAClC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE;gBAC5D,oBAAoB;gBACpB,MAAM,CAAC,MAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;aACnD;iBAAM;gBACL,SAAS;gBACT,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;oBACE,OAAO,EAAE,sCAA+B,MAAI,0BAAuB;oBACnE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;oBACxC,MAAM,EAAE,GAAG;iBACZ,CACF,CAAC;aACH;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,IAAI,IAAI,IAAI,KAAK,mBAAS,CAAC,YAAY,EAAE;YACrE,mBAAmB;YAEnB,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,YAAY,EAAE;oBACnC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM;gBACL,eAAe;gBAEf,QAAQ;gBACR,IAAI;oBACF,MAAM,CAAC,MAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;iBAC1C;gBAAC,OAAO,GAAG,EAAE;oBACZ,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,sCAA+B,MAAI,mCAAgC;wBAC5E,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,MAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,cAAc,EAAE;YACzE,SAAS;YAET,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,cAAc,EAAE;oBACrC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM;gBACL,eAAe;gBAEf,cAAc;gBACd,MAAM,CAAC,MAAI,CAAC,GAAG,KAAK,CAAC;aACtB;SACF;aAAM;YACL,qBAAqB;YACrB,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;gBACE,OAAO,EAAE,yEAAkE,MAAI,MAAG;gBAClF,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;gBACxC,MAAM,EAAE,GAAG;aACZ,CACF,CAAC;SACH;KACF;IAED,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAE5C,kBAAkB;IACZ,IAAA,KAA2B,IAAA,yBAAa,EAAC,IAAI,CAAC,GAAG,CAAC,EAAhD,QAAQ,cAAA,EAAE,UAAU,gBAA4B,CAAC;IACzD,IAAI,CAAC,QAAQ,IAAI,CAAC,UAAU,EAAE;QAC5B,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;YACE,OAAO,EAAE,kEAAkE;YAC3E,IAAI,EAAE,2BAAiB,CAAC,cAAc;YACtC,MAAM,EAAE,GAAG;SACZ,CACF,CAAC;KACH;IAED,qCAAqC;IACrC,IACE,CAAC,UAAU,CAAC,MAAM;WACf,CAAC,UAAU,CAAC,aAAa;WACzB,CAAC,UAAU,CAAC,YAAY;WACxB,CACD,UAAU,CAAC,WAAW;eACnB,CAAC,UAAU,CAAC,OAAO,CACvB;WACE,CACD,CAAC,UAAU,CAAC,KAAK;eACd,CAAC,UAAU,CAAC,SAAS;eACrB,CAAC,UAAU,CAAC,OAAO,CACvB,EACD;QACA,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;YACE,OAAO,EAAE,kEAAkE;YAC3E,IAAI,EAAE,2BAAiB,CAAC,cAAc;YACtC,MAAM,EAAE,GAAG;SACZ,CACF,CAAC;KACH;IAED,4BAA4B;IAC5B,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;IAClC,MAAM,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IAChD,MAAM,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;IAC9C,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC;IAC1C,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;IAClC,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IACtC,MAAM,CAAC,mBAAmB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEtE,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAE5C,mEAAmE;IACnE,IACE,MAAM,CAAC,QAAQ;WACZ,UAAU,CAAC,QAAQ;WACnB,MAAM,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ;WACvC,CAAC,MAAM,CAAC,KAAK;WACb,CAAC,MAAM,CAAC,OAAO,EAClB;QACA,8CAA8C;QAC9C,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;YACE,OAAO,EAAE,6GAA6G;YACtH,IAAI,EAAE,2BAAiB,CAAC,WAAW;YACnC,MAAM,EAAE,GAAG;SACZ,CACF,CAAC;KACH;IAED,0BAA0B;IAC1B,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,kBAAe,YAAY,CAAC"}

package/lib/helpers/showFatalError.d.ts

@@ -0,0 +1,2 @@
+import { showFatalError } from '../components/AppWrapper';
+export default showFatalError;

package/lib/helpers/showFatalError.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var AppWrapper_1 = require("../components/AppWrapper");
+exports.default = AppWrapper_1.showFatalError;
+//# sourceMappingURL=showFatalError.js.map

package/lib/helpers/showFatalError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"showFatalError.js","sourceRoot":"","sources":["../../src/helpers/showFatalError.tsx"],"names":[],"mappings":";;AAAA,uDAA0D;AAE1D,kBAAe,2BAAc,CAAC"}

package/lib/helpers/visitServerEndpoint.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Set the session expiry handler
+ * @author Gabe Abrams
+ * @param handler new handler to use when session expires
+ */
+export declare const setSessionExpiryHandler: (handler: () => void) => void;
+/**
+ * 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
+ */
+declare const visitServerEndpoint: (opts: {
+    path: string;
+    method?: ('GET' | 'POST' | 'DELETE' | 'PUT');
+    params?: {
+        [x: string]: any;
+    };
+}) => Promise<any>;
+export default visitServerEndpoint;

package/lib/helpers/visitServerEndpoint.js

@@ -0,0 +1,135 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setSessionExpiryHandler = void 0;
+// Initialize caccl
+var client_1 = require("caccl/client");
+// Import custom error
+var ErrorWithCode_1 = __importDefault(require("../errors/ErrorWithCode"));
+var ReactKitErrorCode_1 = __importDefault(require("../types/ReactKitErrorCode"));
+/*------------------------------------------------------------------------*/
+/*                                Listener                                */
+/*------------------------------------------------------------------------*/
+// Handler for session expiry
+var sessionExpiryHandler;
+// Keep track of whether or not session expiry has already been handled
+var sessionAlreadyExpired = false;
+/**
+ * Set the session expiry handler
+ * @author Gabe Abrams
+ * @param handler new handler to use when session expires
+ */
+var setSessionExpiryHandler = function (handler) {
+    sessionExpiryHandler = handler;
+};
+exports.setSessionExpiryHandler = setSessionExpiryHandler;
+/*------------------------------------------------------------------------*/
+/*                                  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
+ */
+var visitServerEndpoint = function (opts) { return __awaiter(void 0, void 0, void 0, function () {
+    var response, body;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, client_1.sendRequest)({
+                    path: opts.path,
+                    method: opts.method,
+                    params: opts.params,
+                })];
+            case 1:
+                response = _a.sent();
+                // Check for failure
+                if (!response || !response.body) {
+                    throw new ErrorWithCode_1.default('We didn\'t get a response from the server. Please check your internet connection.', ReactKitErrorCode_1.default.NoResponse);
+                }
+                if (!!response.body.success) return [3 /*break*/, 6];
+                if (!(response.body.code === ReactKitErrorCode_1.default.SessionExpired)) return [3 /*break*/, 5];
+                if (!sessionAlreadyExpired) return [3 /*break*/, 3];
+                // Never return (browser is already reloading)
+                return [4 /*yield*/, new Promise(function () {
+                        // Promise that never returns
+                    })];
+            case 2:
+                // Never return (browser is already reloading)
+                _a.sent();
+                _a.label = 3;
+            case 3:
+                sessionAlreadyExpired = true;
+                // Show session expiration message
+                if (sessionExpiryHandler) {
+                    // Use handler
+                    sessionExpiryHandler();
+                }
+                else {
+                    // Fallback to alert
+                    // eslint-disable-next-line no-alert
+                    alert('Your session has expired. Please start over.');
+                }
+                // Never return (don't continue execution)
+                return [4 /*yield*/, new Promise(function () {
+                        // Promise that never returns
+                    })];
+            case 4:
+                // Never return (don't continue execution)
+                _a.sent();
+                _a.label = 5;
+            case 5: 
+            // Other errors
+            throw new ErrorWithCode_1.default((response.body.message
+                || 'An unknown error occurred. Please contact an admin.'), (response.body.code
+                || ReactKitErrorCode_1.default.NoCode));
+            case 6:
+                body = response.body.body;
+                // Return
+                return [2 /*return*/, body];
+        }
+    });
+}); };
+exports.default = visitServerEndpoint;
+//# sourceMappingURL=visitServerEndpoint.js.map

package/lib/helpers/visitServerEndpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitServerEndpoint.js","sourceRoot":"","sources":["../../src/helpers/visitServerEndpoint.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mBAAmB;AACnB,uCAA2C;AAE3C,sBAAsB;AACtB,0EAAoD;AACpD,iFAA2D;AAE3D,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,6BAA6B;AAC7B,IAAI,oBAAgC,CAAC;AAErC,uEAAuE;AACvE,IAAI,qBAAqB,GAAG,KAAK,CAAC;AAElC;;;;GAIG;AACI,IAAM,uBAAuB,GAAG,UAAC,OAAmB;IACzD,oBAAoB,GAAG,OAAO,CAAC;AACjC,CAAC,CAAC;AAFW,QAAA,uBAAuB,2BAElC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E;;;;;;;;GAQG;AACH,IAAM,mBAAmB,GAAG,UAC1B,IAIC;;;;oBAGgB,qBAAM,IAAA,oBAAW,EAAC;oBACjC,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;iBACpB,CAAC,EAAA;;gBAJI,QAAQ,GAAG,SAIf;gBAEF,oBAAoB;gBACpB,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAC/B,MAAM,IAAI,uBAAa,CACrB,mFAAmF,EACnF,2BAAiB,CAAC,UAAU,CAC7B,CAAC;iBACH;qBACG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAtB,wBAAsB;qBAEpB,CAAA,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,2BAAiB,CAAC,cAAc,CAAA,EAAvD,wBAAuD;qBAErD,qBAAqB,EAArB,wBAAqB;gBACvB,8CAA8C;gBAC9C,qBAAM,IAAI,OAAO,CAA2B;wBAC1C,6BAA6B;oBAC/B,CAAC,CAAC,EAAA;;gBAHF,8CAA8C;gBAC9C,SAEE,CAAC;;;gBAEL,qBAAqB,GAAG,IAAI,CAAC;gBAE7B,kCAAkC;gBAClC,IAAI,oBAAoB,EAAE;oBACxB,cAAc;oBACd,oBAAoB,EAAE,CAAC;iBACxB;qBAAM;oBACL,oBAAoB;oBAEpB,oCAAoC;oBACpC,KAAK,CAAC,8CAA8C,CAAC,CAAC;iBACvD;gBAED,0CAA0C;gBAC1C,qBAAM,IAAI,OAAO,CAA2B;wBAC1C,6BAA6B;oBAC/B,CAAC,CAAC,EAAA;;gBAHF,0CAA0C;gBAC1C,SAEE,CAAC;;;YAGL,eAAe;YACf,MAAM,IAAI,uBAAa,CACrB,CACE,QAAQ,CAAC,IAAI,CAAC,OAAO;mBAClB,qDAAqD,CACzD,EACD,CACE,QAAQ,CAAC,IAAI,CAAC,IAAI;mBACf,2BAAiB,CAAC,MAAM,CAC5B,CACF,CAAC;;gBAII,IAAI,GAAK,QAAQ,CAAC,IAAI,KAAlB,CAAmB;gBAE/B,SAAS;gBACT,sBAAO,IAAI,EAAC;;;KACb,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}

package/lib/types/ParamType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * API param types
+ * @author Gabe Abrams
+ */
+declare enum ParamType {
+    Boolean = "boolean",
+    BooleanOptional = "boolean-optional",
+    Float = "float",
+    FloatOptional = "float-optional",
+    Int = "int",
+    IntOptional = "int-optional",
+    JSON = "json",
+    JSONOptional = "json-optional",
+    String = "string",
+    StringOptional = "string-optional"
+}
+export default ParamType;

package/lib/types/ParamType.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * API param types
+ * @author Gabe Abrams
+ */
+var ParamType;
+(function (ParamType) {
+    ParamType["Boolean"] = "boolean";
+    ParamType["BooleanOptional"] = "boolean-optional";
+    ParamType["Float"] = "float";
+    ParamType["FloatOptional"] = "float-optional";
+    ParamType["Int"] = "int";
+    ParamType["IntOptional"] = "int-optional";
+    ParamType["JSON"] = "json";
+    ParamType["JSONOptional"] = "json-optional";
+    ParamType["String"] = "string";
+    ParamType["StringOptional"] = "string-optional";
+})(ParamType || (ParamType = {}));
+exports.default = ParamType;
+//# sourceMappingURL=ParamType.js.map

package/lib/types/ParamType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ParamType.js","sourceRoot":"","sources":["../../src/types/ParamType.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAK,SAWJ;AAXD,WAAK,SAAS;IACZ,gCAAmB,CAAA;IACnB,iDAAoC,CAAA;IACpC,4BAAe,CAAA;IACf,6CAAgC,CAAA;IAChC,wBAAW,CAAA;IACX,yCAA4B,CAAA;IAC5B,0BAAa,CAAA;IACb,2CAA8B,CAAA;IAC9B,8BAAiB,CAAA;IACjB,+CAAkC,CAAA;AACpC,CAAC,EAXI,SAAS,KAAT,SAAS,QAWb;AAED,kBAAe,SAAS,CAAC"}

package/lib/types/ReactKitErrorCode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * List of error codes built into the react kit
+ * @author Gabe Abrams
+ */
+declare enum ReactKitErrorCode {
+    NoResponse = "DRK1",
+    NoCode = "DRK2",
+    SessionExpired = "DRK3",
+    MissingParameter = "DRK4",
+    InvalidParameter = "DRK5",
+    WrongCourse = "DRK6"
+}
+export default ReactKitErrorCode;

package/lib/types/ReactKitErrorCode.js

@@ -0,0 +1,18 @@
+"use strict";
+// Highest error code = DRK2
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * List of error codes built into the react kit
+ * @author Gabe Abrams
+ */
+var ReactKitErrorCode;
+(function (ReactKitErrorCode) {
+    ReactKitErrorCode["NoResponse"] = "DRK1";
+    ReactKitErrorCode["NoCode"] = "DRK2";
+    ReactKitErrorCode["SessionExpired"] = "DRK3";
+    ReactKitErrorCode["MissingParameter"] = "DRK4";
+    ReactKitErrorCode["InvalidParameter"] = "DRK5";
+    ReactKitErrorCode["WrongCourse"] = "DRK6";
+})(ReactKitErrorCode || (ReactKitErrorCode = {}));
+exports.default = ReactKitErrorCode;
+//# sourceMappingURL=ReactKitErrorCode.js.map

package/lib/types/ReactKitErrorCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReactKitErrorCode.js","sourceRoot":"","sources":["../../src/types/ReactKitErrorCode.tsx"],"names":[],"mappings":";AAAA,4BAA4B;;AAE5B;;;GAGG;AACH,IAAK,iBAOJ;AAPD,WAAK,iBAAiB;IACpB,wCAAmB,CAAA;IACnB,oCAAe,CAAA;IACf,4CAAuB,CAAA;IACvB,8CAAyB,CAAA;IACzB,8CAAyB,CAAA;IACzB,yCAAoB,CAAA;AACtB,CAAC,EAPI,iBAAiB,KAAjB,iBAAiB,QAOrB;AAED,kBAAe,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "2.0.1",
+  "version": "2.0.4",
   "main": "index.js",
   "module": "index.js",
   "scripts": {
@@ -18,9 +18,11 @@
     "@fortawesome/free-regular-svg-icons": "^6.1.1",
     "@fortawesome/free-solid-svg-icons": "^6.1.1",
     "@fortawesome/react-fontawesome": "^0.1.18",
+    "caccl": "^2.0.0-beta.39",
     "react-bootstrap": "^2.2.3"
   },
   "devDependencies": {
+    "@types/express": "^4.17.13",
     "@typescript-eslint/eslint-plugin": "^5.18.0",
     "@typescript-eslint/parser": "^5.18.0",
     "eslint": "^8.12.0",

package/src/components/AppWrapper.tsx

@@ -0,0 +1,177 @@
+/**
+ * A wrapper for the entire React app that adds global functionality like
+ *   handling for fatal error messages
+ * @author Gabe Abrams
+ */
+
+// Import 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';
+
+// Import custom errors
+import ErrorWithCode from '../errors/ErrorWithCode';
+
+/*------------------------------------------------------------------------*/
+/*                                  Props                                 */
+/*------------------------------------------------------------------------*/
+
+type Props = {
+  // The entire app
+  children: React.ReactNode,
+  // True if this app is a dark-themed app
+  dark?: boolean,
+  // Custom session expired message
+  sessionExpiredMessage?: string,
+};
+
+/*------------------------------------------------------------------------*/
+/*                             Static Helpers                             */
+/*------------------------------------------------------------------------*/
+
+// Stored copies of setters
+let setFatalErrorMessage: (message: string) => void;
+let setFatalErrorCode: (code: string) => void;
+
+/**
+ * Show a fatal error message
+ * @author Gabe Abrams
+ * @param error the error to show
+ */
+export const showFatalError = (error: any) => {
+  // Determine message and code
+  const message: string = (
+    typeof error === 'string'
+      ? error.trim()
+      : String(error.message ?? 'An unknown error occurred.')
+  );
+  const code: string = (
+    typeof error === 'string'
+      ? ReactKitErrorCode.NoCode
+      : String(error.code ?? ReactKitErrorCode.NoCode)
+  );
+
+  // Handle case where app hasn't loaded
+  if (!setFatalErrorMessage || !setFatalErrorCode) {
+    return alert(`An error has occurred: ${message} (code: ${code}). Please contact support.`);
+  }
+
+  // Use setters
+  setFatalErrorMessage(message);
+  setFatalErrorCode(code);
+};
+
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+
+const AppWrapper = (props: Props) => {
+  /*------------------------------------------------------------------------*/
+  /*                                  Setup                                 */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  const {
+    children,
+    dark,
+    sessionExpiredMessage = 'Your session has expired. Please go back to Canvas and start over.',
+  } = props;
+
+  /* -------------- State ------------- */
+
+  // Fatal error
+  const [fatalErrorMessage, setFatalErrorMessageInner] = useState(null);
+  setFatalErrorMessage = setFatalErrorMessageInner;
+  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 || sessionHasExpired) {
+    // Re-encapsulate in an error
+    const error = (
+      sessionHasExpired
+        ? new ErrorWithCode(
+          fatalErrorMessage,
+          fatalErrorCode,
+        )
+        : new ErrorWithCode(
+          sessionExpiredMessage,
+          ReactKitErrorCode.SessionExpired,
+        )
+    );
+
+    // Build error screen
+    return (
+      <div
+        style={{
+          display: 'block',
+          width: '100vw',
+          minHeight: '100vh',
+          paddingTop: '10rem',
+          backgroundColor: (
+            dark
+              ? '#222'
+              : '#fff'
+          ),
+        }}
+      >
+        <ErrorBox
+          title={(
+            sessionHasExpired
+              ? 'Session Expired'
+              : undefined
+          )}
+          error={error}
+        />
+      </div>
+    );
+  }
+
+  // Show the app itself
+  return children;
+};
+
+/*------------------------------------------------------------------------*/
+/*                                 Wrap Up                                */
+/*------------------------------------------------------------------------*/
+
+// Export component
+export default AppWrapper;

package/src/components/ErrorBox.tsx

@@ -0,0 +1,124 @@
+/**
+ * Displays an error
+ * @author Gabe Abrams
+ */
+
+// Import React
+import React from 'react';
+
+// Import FontAwesome Icons
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faExclamationTriangle } from '@fortawesome/free-solid-svg-icons';
+
+// Import shared types
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
+/*------------------------------------------------------------------------*/
+/*                                  Types                                 */
+/*------------------------------------------------------------------------*/
+
+type Props = {
+  // Error to display
+  error: any,
+  // Customized title of error box
+  title?: string,
+  // Handler for close,
+  onClose?: () => void,
+};
+
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+
+const ErrorBox: React.FC<Props> = (props) => {
+  /*------------------------------------------------------------------------*/
+  /*                                  Setup                                 */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  const {
+    error,
+    title = 'An Error Occurred',
+    onClose,
+  } = props;
+
+  /*------------------------------------------------------------------------*/
+  /*                                 Render                                 */
+  /*------------------------------------------------------------------------*/
+
+  // Determine error text
+  const errorText: string = (
+    typeof error === 'string'
+      ? error.trim()
+      : String(error.message || 'An unknown error occurred. Please contact support.')
+  );
+
+  // Error code box
+  let errorCodeBox;
+  if (error && (error as any).code) {
+    errorCodeBox = (
+      <span>
+        {' '}
+        <span
+          style={{
+            backgroundColor: 'white',
+            borderRadius: '5px',
+            paddingLeft: '3px',
+            paddingRight: '3px',
+            color: '#DC4150',
+            fontVariant: 'small-caps',
+            fontSize: '80%',
+            whiteSpace: 'nowrap',
+          }}
+        >
+          code:
+          {' '}
+          {String((error as any).code ?? ReactKitErrorCode.NoCode).toUpperCase()}
+        </span>
+      </span>
+    );
+  }
+
+  // Main UI
+  return (
+    <div
+      className="alert alert-danger text-center"
+      style={{
+        maxWidth: '650px',
+        margin: 'auto',
+      }}
+    >
+      <h4 className="mb-1">
+        <FontAwesomeIcon
+          icon={faExclamationTriangle}
+          className="me-2"
+        />
+        {title}
+      </h4>
+      <div>
+        {errorText}
+        {errorCodeBox}
+      </div>
+      {onClose && (
+        <div className="mt-2">
+          <button
+            type="button"
+            className="btn btn-light"
+            aria-label="dismiss error and close this activity or view"
+            onClick={onClose}
+          >
+            Close
+          </button>
+        </div>
+      )}
+    </div>
+  );
+};
+
+/*------------------------------------------------------------------------*/
+/*                                 Wrap Up                                */
+/*------------------------------------------------------------------------*/
+
+// Export component
+export default ErrorBox;

package/src/errors/ErrorWithCode.tsx

@@ -0,0 +1,15 @@
+/**
+ * An error with a code
+ * @author Gabe Abrams
+ */
+class ErrorWithCode extends Error {
+  code: string;
+
+  constructor(message: string, code: string) {
+    super(message);
+    this.name = 'ErrorWithCode';
+    this.code = code;
+  }
+}
+
+export default ErrorWithCode;