dce-reactkit 3.0.0-beta.4 → 3.0.0-beta.42

package/src/helpers/getOrdinal.tsx

@@ -0,0 +1,13 @@
+const ORDINALS = ['th', 'st', 'nd', 'rd'];
+
+/**
+ * Get a number's ordinal
+ * @author Gabe Abrams
+ * @param num the number being analyzed
+ * @returns ordinal
+ */
+const getOrdinal = (num: number): string => {
+  return (ORDINALS[(num - 20) % 10] ?? ORDINALS[num] ?? ORDINALS[0]);
+};
+
+export default getOrdinal;

package/src/helpers/getTimeInfoInET.tsx

@@ -0,0 +1,56 @@
+/**
+ * Get current time info in US Boston Eastern Time, independent of machine
+ *   timezone
+ * @author Gabe Abrams
+ * @param {Date} [date=now] the date to get info on
+ * @returns object with timestamp (ms since epoch) and numbers
+ *   corresponding to ET time values for year, month, day, hour, minute
+ */
+const getTimeInfoInET = (date?: Date): {
+  timestamp: number,
+  year: number,
+  month: number,
+  day: number,
+  hour: number,
+  minute: number,
+} => {
+  // Create a time string
+  const d = (date || new Date());
+  const str = d.toLocaleString(
+    'en-US', // Using US encoding (it's the only one installed on containers)
+    { timeZone: 'America/New_York' } // Force EST timezone
+  );
+
+  // Parse the string for the date/time info
+  const [dateStr, timeStr] = str.split(', '); // Format: MM/DD/YYYY, HH:MM:SS AM
+  const [monthStr, dayStr, yearStr] = dateStr.split('/'); // Format: MM/DD/YYYY
+  const [hourStr, minStr, ending] = timeStr.split(':'); // Format: HH:MM:SS AM
+
+  // Create all time numbers
+  const timestamp = d.getTime();
+  const year = Number.parseInt(yearStr, 10);
+  const month = Number.parseInt(monthStr, 10);
+  const day = Number.parseInt(dayStr, 10);
+  const minute = Number.parseInt(minStr, 10);
+  let hour = Number.parseInt(hourStr, 10);
+  // Convert from am/pm to 24hr
+  const isAM = ending.toLowerCase().includes('am');
+  const isPM = !isAM;
+  if (isPM && hour !== 12) {
+    hour += 12;
+  } else if (isAM && hour === 12) {
+    hour = 0;
+  }
+
+  // Return
+  return {
+    timestamp,
+    year,
+    month,
+    day,
+    hour,
+    minute,
+  };
+};
+
+export default getTimeInfoInET;

package/src/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/src/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/src/helpers/visitServerEndpoint.tsx

@@ -0,0 +1,110 @@
+// Import custom error
+import ErrorWithCode from '../errors/ErrorWithCode';
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
+// Import helpers from app wrapper
+import { cacclSendRequest } from '../components/AppWrapper';
+
+/*------------------------------------------------------------------------*/
+/*                                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 cacclSendRequest({
+    path: opts.path,
+    method: opts.method ?? '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.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/src/index.ts

@@ -4,6 +4,10 @@ import LoadingSpinner from './components/LoadingSpinner';
 import ErrorBox from './components/ErrorBox';
 import Modal from './components/Modal';
 import TabBox from './components/TabBox';
+import RadioButton from './components/RadioButton';
+import CheckboxButton from './components/CheckboxButton';
+import ButtonInputGroup from './components/ButtonInputGroup';
+import SimpleDateChooser from './components/SimpleDateChooser';
 
 // Import errors
 import ErrorWithCode from './errors/ErrorWithCode';
@@ -19,6 +23,13 @@ import padZerosLeft from './helpers/padZerosLeft';
 import roundToNumDecimals from './helpers/roundToNumDecimals';
 import sum from './helpers/sum';
 import waitMs from './helpers/waitMs';
+import visitServerEndpoint from './helpers/visitServerEndpoint';
+import genRouteHandler from './helpers/genRouteHandler';
+import handleError from './helpers/handleError';
+import handleSuccess from './helpers/handleSuccess';
+import initServer from './server/initServer';
+import getOrdinal from './helpers/getOrdinal';
+import getTimeInfoInET from './helpers/getTimeInfoInET';
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -26,6 +37,7 @@ import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
 import ReactKitErrorCode from './types/ReactKitErrorCode';
 import Variant from './types/Variant';
+import ParamType from './types/ParamType';
 
 // Export each item
 export {
@@ -35,6 +47,10 @@ export {
   ErrorBox,
   Modal,
   TabBox,
+  RadioButton,
+  CheckboxButton,
+  ButtonInputGroup,
+  SimpleDateChooser,
   // Global functions
   alert,
   confirm,
@@ -52,10 +68,21 @@ export {
   roundToNumDecimals,
   sum,
   waitMs,
+  getOrdinal,
+  getTimeInfoInET,
+  // Client helpers
+  visitServerEndpoint,
+  // Server helpers
+  initServer,
+  genRouteHandler,
+  handleError,
+  handleSuccess,
   // Types
   ModalButtonType,
   ModalSize,
   ModalType,
   ReactKitErrorCode,
   Variant,
+  // Server types
+  ParamType,
 };

package/src/server/initServer.ts

@@ -0,0 +1,53 @@
+// Import custom error
+import ErrorWithCode from '../errors/ErrorWithCode';
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
+// Types
+type GetLaunchInfoFunction = (req: any) => {
+  launched: boolean,
+  launchInfo?: any,
+};
+
+// Stored copy of caccl functions
+let _cacclGetLaunchInfo: GetLaunchInfoFunction;
+
+/*------------------------------------------------------------------------*/
+/*                                 Helpers                                */
+/*------------------------------------------------------------------------*/
+
+/**
+ * Get launch info via CACCL
+ * @author Gabe Abrams
+ * @param req express request object
+ * @returns object { launched, launchInfo }
+ */
+export const cacclGetLaunchInfo: GetLaunchInfoFunction = (req: any) => {
+  if (!_cacclGetLaunchInfo) {
+    throw new ErrorWithCode(
+      'Could not get launch info because server was not initialized with dce-reactkit\'s initServer function',
+      ReactKitErrorCode.NoCACCLGetLaunchInfoFunction,
+    );
+  }
+
+  return _cacclGetLaunchInfo(req);
+};
+
+/*------------------------------------------------------------------------*/
+/*                                  Main                                  */
+/*------------------------------------------------------------------------*/
+
+/**
+ * Prepare dce-reactkit to run on the server
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.getLaunchInfo CACCL LTI's get launch info function
+ */
+const initServer = (
+  opts: {
+    getLaunchInfo: GetLaunchInfoFunction,
+  },
+) => {
+  _cacclGetLaunchInfo = opts.getLaunchInfo;
+};
+
+export default initServer;

package/src/types/ParamType.ts

@@ -0,0 +1,18 @@
+/**
+ * Server-side 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/src/types/ReactKitErrorCode.tsx

@@ -1,4 +1,4 @@
-// Highest error code = DRK2
+// Highest error code = DRK8
 
 /**
  * List of error codes built into the react kit
@@ -11,6 +11,8 @@ enum ReactKitErrorCode {
   MissingParameter = 'DRK4',
   InvalidParameter = 'DRK5',
   WrongCourse = 'DRK6',
+  NoCACCLSendRequestFunction = 'DRK7',
+  NoCACCLGetLaunchInfoFunction = 'DRK8',
 }
 
 export default ReactKitErrorCode;