dce-reactkit 2.0.3 → 2.0.6

package/lib/helpers/visitServerEndpoint.tsx

@@ -0,0 +1,110 @@
+// Initialize caccl
+import { sendRequest } from 'caccl/client';
+
+// Import custom error
+import ErrorWithCode from '../errors/ErrorWithCode';
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
+/*------------------------------------------------------------------------*/
+/*                                Listener                                */
+/*------------------------------------------------------------------------*/
+
+// Handler for session expiry
+let sessionExpiryHandler: () => void;
+
+// Keep track of whether or not session expiry has already been handled
+let sessionAlreadyExpired = false;
+
+/**
+ * Set the session expiry handler
+ * @author Gabe Abrams
+ * @param handler new handler to use when session expires
+ */
+export const setSessionExpiryHandler = (handler: () => void) => {
+  sessionExpiryHandler = handler;
+};
+
+/*------------------------------------------------------------------------*/
+/*                                  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 = async (
+  opts: {
+    path: string,
+    method?: ('GET' | 'POST' | 'DELETE' | 'PUT'),
+    params?: { [key in string]: any },
+  },
+): Promise<any> => {
+  // Send the request
+  const response = await sendRequest({
+    path: opts.path,
+    method: opts.method,
+    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.NoResponse,
+    );
+  }
+  if (!response.body.success) {
+    // Session expired
+    if (response.body.code === ReactKitErrorCode.SessionExpired) {
+      // Skip notice if session was already expired
+      if (sessionAlreadyExpired) {
+        // Never return (browser is already reloading)
+        await new Promise<{ [key in string]: any }>(() => {
+          // Promise that never returns
+        });
+      }
+      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)
+      await new Promise<{ [key in string]: any }>(() => {
+        // Promise that never returns
+      });
+    }
+
+    // Other errors
+    throw new ErrorWithCode(
+      (
+        response.body.message
+        || 'An unknown error occurred. Please contact an admin.'
+      ),
+      (
+        response.body.code
+        || ReactKitErrorCode.NoCode
+      ),
+    );
+  }
+
+  // Success! Extract the body
+  const { body } = response.body;
+
+  // Return
+  return body;
+};
+
+export default visitServerEndpoint;

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/ParamType.ts

@@ -0,0 +1,18 @@
+/**
+ * API param types
+ * @author Gabe Abrams
+ */
+enum ParamType {
+  Boolean = 'boolean', // Boolean
+  BooleanOptional = 'boolean-optional', // Optional boolean
+  Float = 'float', // Float Number
+  FloatOptional = 'float-optional', // Optional Float Number
+  Int = 'int', // Integer Number
+  IntOptional = 'int-optional', // Optional Integer Number
+  JSON = 'json', // JSONified object
+  JSONOptional = 'json-optional', // Optional JSONified object
+  String = 'string', // String
+  StringOptional = 'string-optional', // Optional string
+}
+
+export default ParamType;

package/lib/types/ReactKitErrorCode.d.ts

@@ -4,6 +4,10 @@
  */
 declare enum ReactKitErrorCode {
     NoResponse = "DRK1",
-    NoCode = "DRK2"
+    NoCode = "DRK2",
+    SessionExpired = "DRK3",
+    MissingParameter = "DRK4",
+    InvalidParameter = "DRK5",
+    WrongCourse = "DRK6"
 }
 export default ReactKitErrorCode;

package/lib/types/ReactKitErrorCode.js

@@ -9,6 +9,10 @@ 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

@@ -1 +1 @@
-{"version":3,"file":"ReactKitErrorCode.js","sourceRoot":"","sources":["../../src/types/ReactKitErrorCode.tsx"],"names":[],"mappings":";AAAA,4BAA4B;;AAE5B;;;GAGG;AACH,IAAK,iBAGJ;AAHD,WAAK,iBAAiB;IACpB,wCAAmB,CAAA;IACnB,oCAAe,CAAA;AACjB,CAAC,EAHI,iBAAiB,KAAjB,iBAAiB,QAGrB;AAED,kBAAe,iBAAiB,CAAC"}
+{"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/{src → lib}/types/ReactKitErrorCode.tsx

@@ -7,6 +7,10 @@
 enum ReactKitErrorCode {
   NoResponse = 'DRK1',
   NoCode = 'DRK2',
+  SessionExpired = 'DRK3',
+  MissingParameter = 'DRK4',
+  InvalidParameter = 'DRK5',
+  WrongCourse = 'DRK6',
 }
 
 export default ReactKitErrorCode;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "dce-reactkit",
-  "version": "2.0.3",
+  "version": "2.0.6",
   "main": "index.js",
   "module": "index.js",
   "scripts": {
-    "build": "tsc --project ./tsconfig.json"
+    "build": "rimraf lib/ && tsc --project ./tsconfig.json && copyfiles -u 1 src/**/*.tsx src/**/*.ts lib/"
   },
   "repository": {
     "type": "git",
@@ -22,8 +22,10 @@
     "react-bootstrap": "^2.2.3"
   },
   "devDependencies": {
+    "@types/express": "^4.17.13",
     "@typescript-eslint/eslint-plugin": "^5.18.0",
     "@typescript-eslint/parser": "^5.18.0",
+    "copyfiles": "^2.4.1",
     "eslint": "^8.12.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.0.0",
@@ -32,6 +34,7 @@
     "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-react": "^7.29.4",
     "eslint-plugin-react-hooks": "^4.4.0",
+    "rimraf": "^3.0.2",
     "typescript": "^4.6.3"
   }
 }

package/tsconfig.json

@@ -10,7 +10,7 @@
     "target": "es5",
     "jsx": "react-jsx",
     "lib": [
-      "es2015",
+      "es2017",
       "dom"
     ],
     "outDir": "./lib"

package/src/helpers/visitServerEndpoint.tsx

@@ -1,59 +0,0 @@
-// Initialize caccl
-import { sendRequest } from 'caccl/client';
-
-// Import custom error
-import ErrorWithCode from '../errors/ErrorWithCode';
-import ReactKitErrorCode from '../types/ReactKitErrorCode';
-
-/**
- * Visit an endpoint on the server
- * @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 = async (
-  opts: {
-    path: string,
-    method?: ('GET' | 'POST' | 'DELETE' | 'PUT'),
-    params?: { [key in string]: any },
-  },
-): Promise<any> => {
-  // Send the request
-  const response = await sendRequest({
-    path: opts.path,
-    method: opts.method,
-    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.NoResponse,
-    );
-  }
-  if (!response.body.success) {
-    // Other errors
-    throw new ErrorWithCode(
-      (
-        response.body.message
-        || 'An unknown error occurred. Please contact an admin.'
-      ),
-      (
-        response.body.code
-        || ReactKitErrorCode.NoCode
-      ),
-    );
-  }
-
-  // Success! Extract the body
-  const { body } = response.body;
-
-  // Return
-  return body;
-};
-
-export default visitServerEndpoint;