dce-reactkit 3.10.3 → 3.11.0

package/dist/esm/types/client/initClient.d.ts

@@ -19,6 +19,12 @@ type SendRequestFunction = (opts: {
         [x: string]: any;
     };
 }>;
+declare let noServer: boolean;
+/**
+ * Check if there is no server for this app
+ * @author Gabe Abrams
+ */
+export declare const appHasNoServer: () => boolean;
 /**
  * Get the send request function
  * @author Gabe Abrams
@@ -44,10 +50,18 @@ export declare const isDarkModeOn: () => boolean;
  * @param opts object containing all arguments
  * @param opts.sendRequest caccl send request functions
  * @param [opts.sessionExpiredMessage] a custom session expired message
+ * @param [opts.darkModeOn] if true, dark mode is enabled
+ * @param [opts.noServer] if true, there is no server for this app
  */
-declare const initClient: (opts: {
+declare const initClient: (opts: ({
     sendRequest: SendRequestFunction;
     sessionExpiredMessage?: string;
     darkModeOn?: boolean;
-}) => void;
+    noServer?: false;
+} | {
+    darkModeOn?: boolean;
+    noServer: true;
+    sendRequest?: undefined;
+    sessionExpiredMessage?: undefined;
+})) => void;
 export default initClient;

package/dist/index.d.ts

@@ -810,12 +810,20 @@ type SendRequestFunction = (opts: {
  * @param opts object containing all arguments
  * @param opts.sendRequest caccl send request functions
  * @param [opts.sessionExpiredMessage] a custom session expired message
+ * @param [opts.darkModeOn] if true, dark mode is enabled
+ * @param [opts.noServer] if true, there is no server for this app
  */
-declare const initClient: (opts: {
+declare const initClient: (opts: ({
     sendRequest: SendRequestFunction;
     sessionExpiredMessage?: string;
     darkModeOn?: boolean;
-}) => void;
+    noServer?: false;
+} | {
+    darkModeOn?: boolean;
+    noServer: true;
+    sendRequest?: undefined;
+    sessionExpiredMessage?: undefined;
+})) => void;
 
 /**
  * Shorten text so it fits into a certain number of chars

package/package.json

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

package/src/client/initClient.tsx

@@ -47,6 +47,18 @@ const initialized = new Promise((resolve) => {
   onInitialized = resolve;
 });
 
+/* ------------ No Server ----------- */
+
+let noServer = false;
+
+/**
+ * Check if there is no server for this app
+ * @author Gabe Abrams
+ */
+export const appHasNoServer = () => {
+  return noServer;
+};
+
 /* ---------- Send Request ---------- */
 
 let storedSendRequest: SendRequestFunction;
@@ -119,20 +131,46 @@ export const isDarkModeOn = () => {
  * @param opts object containing all arguments
  * @param opts.sendRequest caccl send request functions
  * @param [opts.sessionExpiredMessage] a custom session expired message
+ * @param [opts.darkModeOn] if true, dark mode is enabled
+ * @param [opts.noServer] if true, there is no server for this app
  */
 const initClient = (
-  opts: {
-    // Copy of CACCL's send request function
-    sendRequest: SendRequestFunction,
-    // Custom session expired message
-    sessionExpiredMessage?: string,
-    // If true, dark mode is enabled
-    darkModeOn?: boolean,
-  },
+  opts: (
+    | {
+      // Copy of CACCL's send request function
+      sendRequest: SendRequestFunction,
+      // Custom session expired message
+      sessionExpiredMessage?: string,
+      // If true, dark mode is enabled
+      darkModeOn?: boolean,
+      // If true, there is no server for this app
+      noServer?: false,
+    }
+    | {
+      // If true, dark mode is enabled
+      darkModeOn?: boolean,
+      // If true, there is no server for this app
+      noServer: true
+      // Copy of CACCL's send request function
+      sendRequest?: undefined,
+      // Custom session expired message
+      sessionExpiredMessage?: undefined,
+    }
+  ),
 ) => {
-  // Store values
-  storedSendRequest = opts.sendRequest;
-  sessionExpiredMessage = opts.sessionExpiredMessage;
+  // Handle separately if there is no server
+  if (opts.noServer) {
+    // Store values
+    storedSendRequest = async () => {
+      throw new Error('Cannot send requests because there is no server');
+    };
+  } else {
+    // Store values
+    storedSendRequest = opts.sendRequest;
+    sessionExpiredMessage = opts.sessionExpiredMessage;
+  }
+
+  // Handle universal parts
   darkModeOn = !!opts.darkModeOn;
 
   // Mark as initialized

package/src/helpers/logClientEvent.tsx

@@ -7,6 +7,9 @@ import LogLevel from '../types/LogLevel';
 // Import shared functions
 import visitServerEndpoint from './visitServerEndpoint';
 
+// Import status
+import { appHasNoServer } from '../client/initClient';
+
 /* ------- Metadata Populator ------- */
 
 // Type of a metadata populator function
@@ -36,6 +39,11 @@ export const setClientEventMetadataPopulator = (
  * @author Gabe Abrams
  */
 const logClientEvent: LogFunction = async (opts) => {
+  // Don't write to the server if there is none
+  if (appHasNoServer()) {
+    return;
+  }
+
   // Populate metadata
   let metadata = (opts.metadata ?? {});
   if (metadataPopulator) {

package/src/helpers/visitServerEndpoint.tsx

@@ -102,6 +102,7 @@ const visitServerEndpoint = async (
     params?: { [key in string]: any },
   },
 ): Promise<any> => {
+  // Set default method
   const method = (opts.method ?? 'GET');
   // Handle stubs
   const stubResponse = stubResponses[method]?.[opts.path];