dce-expresskit 4.3.5 → 5.0.1

package/src/helpers/genRouteHandler.ts

@@ -1,4 +1,4 @@
-// Import dce-reactkit
+// Import dce-commonkit
 import {
   getTimeInfoInET,
   LogFunction,
@@ -11,9 +11,9 @@ import {
   LogAction,
   LogLevel,
   ParamType,
-  ReactKitErrorCode,
+  CommonKitErrorCode,
   LogSource,
-} from 'dce-reactkit';
+} from 'dce-commonkit';
 
 // Import caccl
 import { getLaunchInfo } from 'caccl/server';
@@ -382,7 +382,7 @@ const genRouteHandler = (
         res,
         {
           message: 'Your session has expired. Please refresh the page and try again.',
-          code: ReactKitErrorCode.SessionExpired,
+          code: CommonKitErrorCode.SessionExpired,
           status: 401,
         },
       );
@@ -437,7 +437,7 @@ const genRouteHandler = (
         res,
         {
           message: 'Your session was invalid. Please refresh the page and try again.',
-          code: ReactKitErrorCode.SessionExpired,
+          code: CommonKitErrorCode.SessionExpired,
           status: 401,
         },
       );
@@ -686,7 +686,7 @@ const genRouteHandler = (
             ? {
               type: LogType.Error,
               errorMessage: (logOpts as any).error.message ?? 'Unknown message',
-              errorCode: (logOpts as any).error.code ?? ReactKitErrorCode.NoCode,
+              errorCode: (logOpts as any).error.code ?? CommonKitErrorCode.NoCode,
               errorStack: (logOpts as any).error.stack ?? 'No stack',
             }
             : {
@@ -730,10 +730,10 @@ const genRouteHandler = (
         } else if (log.type === LogType.Error) {
           // Print to console
           // eslint-disable-next-line no-console
-          console.error('dce-reactkit error log:', log);
+          console.error('dce error log:', log);
         } else {
           // eslint-disable-next-line no-console
-          console.log('dce-reactkit action log:', log);
+          console.log('dce action log:', log);
         }
 
         // Return log entry
@@ -840,7 +840,7 @@ const genRouteHandler = (
      * @param [renderOpts.title=An Error Occurred] title of the error box
      * @param [renderOpts.description=An unknown server error occurred. Please contact support.]
      *   a human-readable description of the error
-     * @param [renderOpts.code=ReactKitErrorCode.NoCode] error code to show
+     * @param [renderOpts.code=CommonKitErrorCode.NoCode] error code to show
      * @param [renderOpts.pageTitle=renderOpts.title] title of the page/tab if it differs from
      *   the title of the error
      * @param [renderOpts.status=500] http status code

package/src/helpers/getLogReviewerLogs.ts

@@ -1,13 +1,13 @@
 // Import dce-mango
 import { Collection } from 'dce-mango';
 
-// Import dce-reactkit
+// Import dce-commonkit
 import {  
   DAY_IN_MS,
   Log,
   LogReviewerFilterState, 
   LogType 
-} from 'dce-reactkit';
+} from 'dce-commonkit';
 
 // Import shared types
 import LOG_REVIEW_PAGE_SIZE from '../constants/LOG_REVIEW_PAGE_SIZE';

package/src/helpers/handleError.ts

@@ -1,6 +1,5 @@
 // Import shared types
-import { ReactKitErrorCode } from 'dce-reactkit';
-import ExpressKitErrorCode from '../types/ExpressKitErrorCode';
+import { CommonKitErrorCode } from 'dce-commonkit';
 
 /**
  * Handle an error and respond to the client
@@ -42,7 +41,7 @@ const handleError = (
   }
 
   // Get the error code
-  const code = (error.code || ReactKitErrorCode.NoCode);
+  const code = (error.code || CommonKitErrorCode.NoCode);
 
   // Get the status code
   const status = (error.status || 500);

package/src/helpers/initExpressKitCollections.ts

@@ -1,8 +1,8 @@
 // Import dce-mango
 import { Collection as MangoCollection } from 'dce-mango';
 
-// Import dce-reactkit
-import { Log } from 'dce-reactkit';
+// Import dce-commonkit
+import { Log } from 'dce-commonkit';
 
 // Import shared types
 import CrossServerCredential from '../types/CrossServerCredential';

package/src/helpers/initServer.ts

@@ -1,7 +1,7 @@
 // Import express
 import express from 'express';
 
-// Import dce-reactkit
+// Import dce-commonkit
 import {
   ParamType,
   LogFunction,
@@ -10,7 +10,7 @@ import {
   LOG_REVIEW_GET_LOGS_ROUTE,
   SELECT_ADMIN_CHECK_ROUTE,
   ErrorWithCode,
-} from 'dce-reactkit';
+} from 'dce-commonkit';
 
 // Import shared helpers
 import genRouteHandler from './genRouteHandler';
@@ -30,7 +30,7 @@ import {
 /*------------------------------------------------------------------------*/
 
 /**
- * Prepare dce-reactkit to run on the server
+ * Prepare dce-commonkit to run on the server
  * @author Gabe Abrams
  * @param opts object containing all arguments
  * @param opts.app express app from inside of the postprocessor function that

package/src/helpers/visitEndpointOnAnotherServer/index.ts

@@ -1,8 +1,8 @@
-// Import dce-reactkit
+// Import dce-commonkit
 import {
   ErrorWithCode,
-  ReactKitErrorCode,
-} from 'dce-reactkit';
+  CommonKitErrorCode,
+} from 'dce-commonkit';
 
 // Import shared types
 import sendServerToServerRequest from './sendServerToServerRequest';
@@ -20,6 +20,9 @@ import sendServerToServerRequest from './sendServerToServerRequest';
  * @param opts.host the host of the other server
  * @param [opts.params={}] query/body parameters to include
  * @param [opts.responseType=JSON] the response type from the other server
+ * @param [opts.dceKitCrossServerCredentials] additional cross-server credentials
+ *   that aren't in the env var list
+ * @returns the body of the response from the other server
  */
 const visitEndpointOnAnotherServer = async (
   opts: {
@@ -28,6 +31,7 @@ const visitEndpointOnAnotherServer = async (
     host: string,
     params?: { [key in string]: any },
     responseType?: 'JSON' | 'Text',
+    dceKitCrossServerCredentials?: string,
   },
 ): Promise<any> => {
   // Send the request
@@ -37,13 +41,14 @@ const visitEndpointOnAnotherServer = async (
     method: opts.method,
     params: opts.params,
     responseType: opts.responseType,
+    dceKitCrossServerCredentials: opts.dceKitCrossServerCredentials,
   });
 
   // Check for failure
   if (!response || !response.body) {
     throw new ErrorWithCode(
       'We didn\'t get a response from the other server. Please check the network between the two connection.',
-      ReactKitErrorCode.NoResponse,
+      CommonKitErrorCode.NoResponse,
     );
   }
   if (!response.body.success) {
@@ -55,7 +60,7 @@ const visitEndpointOnAnotherServer = async (
       ),
       (
         response.body.code
-        || ReactKitErrorCode.NoCode
+        || CommonKitErrorCode.NoCode
       ),
     );
   }

package/src/helpers/visitEndpointOnAnotherServer/sendServerToServerRequest.ts

@@ -1,10 +1,10 @@
 // Import libs
 import qs from 'qs';
 
-// Import dce-reactkit
+// Import dce-commonkit
 import {
   ErrorWithCode,
-} from 'dce-reactkit';
+} from 'dce-commonkit';
 
 // Import data signer
 import { signRequest } from '../dataSigner';
@@ -25,37 +25,52 @@ const credentials: {
   host: string,
   key: string,
   secret: string,
-}[] = (
-    (process.env.DCEKIT_CROSS_SERVER_CREDENTIALS ?? '')
-      // Replace multiple | with a single one
-      .replace(/\|+/g, '|')
-      // Split by |
-      .split('|')
-      // Remove empty strings
-      .filter((str) => {
-        return str.trim().length > 0;
-      })
-      // Process each credential
-      .map((str) => {
-        // Split by :
-        const parts = str.split(':');
+}[] = [];
 
-        // Check for errors
-        if (parts.length !== 3) {
-          throw new ErrorWithCode(
-            'Invalid DCEKIT_CROSS_SERVER_CREDENTIALS format. Each credential must be in the format |host:key:secret|',
-            ExpressKitErrorCode.InvalidCrossServerCredentialsFormat,
-          );
-        }
+/*------------------------------------------------------------------------*/
+/* ------------------------------- Helpers ------------------------------ */
+/*------------------------------------------------------------------------*/
 
-        // Return the credential
-        return {
-          host: parts[0].trim(),
-          key: parts[1].trim(),
-          secret: parts[2].trim(),
-        };
-      })
-  );
+/**
+ * Parse a credentials string into an array of credentials
+ * @author Gabe Abrams
+ * @param credentialsStr the credentials string to parse
+ * @returns an array of credentials
+ */
+const parseCredentials = (credentialsStr: string) => {
+  credentialsStr
+    // Replace multiple | with a single one
+    .replace(/\|+/g, '|')
+    // Split by |
+    .split('|')
+    // Remove empty strings
+    .filter((str) => {
+      return str.trim().length > 0;
+    })
+    // Process each credential
+    .forEach((str) => {
+      // Split by :
+      const parts = str.split(':');
+
+      // Check for errors
+      if (parts.length !== 3) {
+        throw new ErrorWithCode(
+          'Invalid DCEKIT_CROSS_SERVER_CREDENTIALS format. Each credential must be in the format |host:key:secret|',
+          ExpressKitErrorCode.InvalidCrossServerCredentialsFormat,
+        );
+      }
+
+      // Add the credential to the array
+      credentials.push({
+        host: parts[0].trim(),
+        key: parts[1].trim(),
+        secret: parts[2].trim(),
+      });
+    });
+};
+
+// Auto-parse credentials from env variable
+parseCredentials(process.env.DCEKIT_CROSS_SERVER_CREDENTIALS ?? '');
 
 /*------------------------------------------------------------------------*/
 /* ------------------------------- Helpers ------------------------------ */
@@ -96,6 +111,8 @@ const getCrossServerCredential = (host: string) => {
  * @param [opts.method=GET] http method to use
  * @param [opts.params] body/data to include in the request
  * @param [opts.responseType=JSON] expected response type
+ * @param [opts.dceKitCrossServerCredentials] additional cross-server credentials
+ *   that aren't in the env var list
  * @returns { body, status, headers } on success
  */
 const sendServerToServerRequest = async (
@@ -105,12 +122,18 @@ const sendServerToServerRequest = async (
     method?: ('GET' | 'POST' | 'PUT' | 'DELETE'),
     params?: { [k in string]: any },
     responseType?: 'Text' | 'JSON',
+    dceKitCrossServerCredentials?: string,
   },
 ): Promise<{
   body: any,
   status: number,
   headers: { [k in string]: any },
 }> => {
+  // If additional credentials were provided, parse them and add to the list
+  if (opts.dceKitCrossServerCredentials) {
+    parseCredentials(opts.dceKitCrossServerCredentials);
+  }
+
   // Process method
   const method: ('GET' | 'POST' | 'PUT' | 'DELETE') = (opts.method || 'GET');
 

package/src/html/genErrorPage.ts

@@ -1,8 +1,5 @@
-// Import dce-reactkit
-import { ReactKitErrorCode } from 'dce-reactkit';
-
-// Import shared types
-import ExpressKitErrorCode from '../types/ExpressKitErrorCode';
+// Import dce-commonkit
+import { CommonKitErrorCode } from 'dce-commonkit';
 
 /**
  * Generate a static error page
@@ -11,7 +8,7 @@ import ExpressKitErrorCode from '../types/ExpressKitErrorCode';
  * @param [opts.title=An Error Occurred] title of the error box
  * @param [opts.description=An unknown server error occurred. Please contact support.]
  *   a human-readable description of the error
- * @param [opts.code=ReactKitErrorCode.NoCode] error code to show
+ * @param [opts.code=CommonKitErrorCode.NoCode] error code to show
  * @param [opts.pageTitle=opts.title] title of the page/tab if it differs from
  *   the title of the error
  * @returns html of the page
@@ -30,7 +27,7 @@ const genErrorPage = (
     opts.description
     ?? 'An unknown server error occurred. Please contact support.'
   );
-  const code = (opts.code ?? ReactKitErrorCode.NoCode);
+  const code = (opts.code ?? CommonKitErrorCode.NoCode);
 
   return `
 <head>

package/src/index.ts

@@ -1,4 +1,4 @@
-// Import dce-reactkit
+// Import dce-commonkit
 import {
   abbreviate,
   avg,
@@ -46,7 +46,7 @@ import {
   DAY_IN_MS,
   ErrorWithCode,
   ParamType,
-} from 'dce-reactkit';
+} from 'dce-commonkit';
 
 // Import helpers
 import initServer from './helpers/initServer';

package/src/errors/ErrorWithCode.tsx

@@ -1,15 +0,0 @@
-/**
- * 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;