dce-reactkit 3.6.1 → 3.6.3

package/dist/esm/types/components/AppWrapper.d.ts

@@ -50,7 +50,7 @@ export declare const confirm: (title: string, text: string, opts?: {
  * @param error the error to show
  * @param [errorTitle] title of the error box
  */
-export declare const showFatalError: (error: any, errorTitle?: string) => undefined;
+export declare const showFatalError: (error: any, errorTitle?: string) => Promise<void>;
 /**
  * Add a handler for when a fatal error occurs
  * @author Gabe Abrams
@@ -60,6 +60,6 @@ export declare const addFatalErrorHandler: (handler: () => void) => void;
  * Show the "session expired" message
  * @author Gabe Abrams
  */
-export declare const showSessionExpiredMessage: () => undefined;
+export declare const showSessionExpiredMessage: () => Promise<void>;
 declare const AppWrapper: React.FC<Props>;
 export default AppWrapper;

package/dist/index.d.ts

@@ -69,7 +69,7 @@ declare const confirm: (title: string, text: string, opts?: {
  * @param error the error to show
  * @param [errorTitle] title of the error box
  */
-declare const showFatalError: (error: any, errorTitle?: string) => undefined;
+declare const showFatalError: (error: any, errorTitle?: string) => Promise<void>;
 /**
  * Add a handler for when a fatal error occurs
  * @author Gabe Abrams

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.6.1",
+  "version": "3.6.3",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/components/AppWrapper.tsx

@@ -33,6 +33,7 @@ import {
   getSessionExpiredMessage,
   isDarkModeOn,
 } from '../client/initClient';
+import waitMs from '../helpers/waitMs';
 
 /*------------------------------------------------------------------------*/
 /* -------------------------------- Props ------------------------------- */
@@ -47,6 +48,32 @@ type Props = {
 /* --------------------------- Static Helpers --------------------------- */
 /*------------------------------------------------------------------------*/
 
+// Timestamp after initialization when helpers should be available
+const timestampWhenHelpersShouldBeAvailable = Date.now() + 2000;
+
+/**
+ * Wait for a little while for a helper to exist
+ * @author Gabe Abrams
+ * @param checkForHelper a function that returns true if the helper exists
+ * @returns true if the helper exists, false if the process timed out
+ */
+const waitForHelper = async (checkForHelper: () => boolean): Promise<boolean> => {
+  // Wait for helper to exist
+  while (!checkForHelper()) {
+    // Check if we should stop waiting
+    if (Date.now() > timestampWhenHelpersShouldBeAvailable) {
+      // Stop waiting
+      return false;
+    }
+
+    // Wait a little while
+    await waitMs(10);
+  }
+
+  // Helper exists
+  return true;
+};
+
 /*----------------------------------------*/
 /* ----------- Redirect/Leave ----------- */
 /*----------------------------------------*/
@@ -103,6 +130,11 @@ let onAlertClosed: () => void;
  * @param text the text to display in the alert
  */
 export const alert = async (title: string, text: string): Promise<undefined> => {
+  // Wait for helper to exist
+  await waitForHelper(() => {
+    return !!setAlertInfo;
+  });
+
   // Fallback if alert not available
   if (!setAlertInfo) {
     // eslint-disable-next-line no-alert
@@ -172,6 +204,11 @@ export const confirm = async (
     cancelButtonVariant?: Variant,
   },
 ): Promise<boolean> => {
+  // Wait for helper to exist
+  await waitForHelper(() => {
+    return !!setConfirmInfo;
+  });
+
   // Fallback if confirm is not available
   if (!setConfirmInfo) {
     // eslint-disable-next-line no-alert
@@ -212,10 +249,10 @@ const fatalErrorHandlers: (() => void)[] = [];
  * @param error the error to show
  * @param [errorTitle] title of the error box
  */
-export const showFatalError = (
+export const showFatalError = async (
   error: any,
   errorTitle: string = 'An Error Occurred',
-): undefined => {
+) => {
   // Determine message and code
   const message: string = (
     typeof error === 'string'
@@ -250,21 +287,27 @@ export const showFatalError = (
     },
   });
 
+  // Wait for helper to exist
+  await waitForHelper(() => {
+    return (
+      !!setFatalErrorMessage
+      && !!setFatalErrorCode
+    );
+  });
+
   // Handle case where app hasn't loaded
   if (!setFatalErrorMessage || !setFatalErrorCode) {
     alert(
       errorTitle,
       `${message} (code: ${code}). Please contact support.`,
     );
-    return undefined;
+    return;
   }
 
   // Use setters
   setFatalErrorMessage(message);
   setFatalErrorCode(code);
   setFatalErrorTitle(errorTitle);
-
-  return undefined;
 };
 
 /**
@@ -286,9 +329,21 @@ let setSessionHasExpired: (isExpired: boolean) => void;
  * Show the "session expired" message
  * @author Gabe Abrams
  */
-export const showSessionExpiredMessage = (): undefined => {
-  setSessionHasExpired(true);
-  return undefined;
+export const showSessionExpiredMessage = async () => {
+  // Wait for helper to exist
+  await waitForHelper(() => {
+    return !!setSessionHasExpired;
+  });
+
+  // Show session expired message
+  if (setSessionHasExpired) {
+    setSessionHasExpired(true);
+  } else {
+    showFatalError(
+      'Your session has expired. Please start over.',
+      'Session Expired',
+    );
+  }
 };
 
 /*------------------------------------------------------------------------*/

package/src/helpers/visitServerEndpoint.tsx

@@ -1,9 +1,42 @@
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable @typescript-eslint/naming-convention */
 // Import custom error
 import ErrorWithCode from '../errors/ErrorWithCode';
 import ReactKitErrorCode from '../types/ReactKitErrorCode';
 
 // Import helpers
 import { getSendRequest } from '../client/initClient';
+import waitMs from './waitMs';
+
+/*------------------------------------------------------------------------*/
+/* --------------------------- Static Helpers --------------------------- */
+/*------------------------------------------------------------------------*/
+
+// Timestamp after initialization when helpers should be available
+const timestampWhenHelpersShouldBeAvailable = Date.now() + 2000;
+
+/**
+ * Wait for a little while for a helper to exist
+ * @author Gabe Abrams
+ * @param checkForHelper a function that returns true if the helper exists
+ * @returns true if the helper exists, false if the process timed out
+ */
+const waitForHelper = async (checkForHelper: () => boolean): Promise<boolean> => {
+  // Wait for helper to exist
+  while (!checkForHelper()) {
+    // Check if we should stop waiting
+    if (Date.now() > timestampWhenHelpersShouldBeAvailable) {
+      // Stop waiting
+      return false;
+    }
+
+    // Wait a little while
+    await waitMs(10);
+  }
+
+  // Helper exists
+  return true;
+};
 
 /*------------------------------------------------------------------------*/
 /*                                Listener                                */
@@ -164,6 +197,11 @@ const visitServerEndpoint = async (
       }
       sessionAlreadyExpired = true;
 
+      // Wait for helper to exist
+      await waitForHelper(() => {
+        return !!sessionExpiryHandler;
+      });
+
       // Show session expiration message
       if (sessionExpiryHandler) {
         // Use handler