dce-reactkit 3.8.6 → 3.8.7

package/dist/esm/types/helpers/visitEndpointOnAnotherServer/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Send a server-to-server request from this sever to another server that uses
+ *   dce-reactkit [for server only]
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.path - the path of the other server's endpoint
+ * @param [opts.method=GET] - the method of the endpoint
+ * @param [opts.params] - query/body parameters to include
+ * @param [opts.headers] - headers to include
+ * @returns response from server
+ */
+declare const visitEndpointOnAnotherServer: (opts: {
+    path: string;
+    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
+    params?: {
+        [x: string]: any;
+    } | undefined;
+    headers?: {
+        [x: string]: any;
+    } | undefined;
+}) => Promise<any>;
+export default visitEndpointOnAnotherServer;

package/dist/esm/types/helpers/visitEndpointOnAnotherServer/sendServerToServerRequest.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Sends and retries an http request
+ * @author Gabriel Abrams
+ * @param opts object containing all arguments
+ * @param opts.path path to send request to
+ * @param [opts.host] host to send request to
+ * @param [opts.method=GET] http method to use
+ * @param [opts.params] body/data to include in the request
+ * @param [opts.headers] headers to include in the request
+ * @param [opts.sendCrossDomainCredentials=true if in development mode] if true,
+ *   send cross-domain credentials even if not in dev mode
+ * @param [opts.responseType=JSON] expected response type
+ * @returns { body, status, headers } on success
+ */
+declare const sendServerToServerRequest: (opts: {
+    path: string;
+    host?: string | undefined;
+    method?: "GET" | "POST" | "DELETE" | "PUT" | undefined;
+    params?: {
+        [x: string]: any;
+    } | undefined;
+    headers?: {
+        [x: string]: any;
+    } | undefined;
+    responseType?: "Text" | "JSON" | undefined;
+}) => Promise<{
+    body: any;
+    status: number;
+    headers: {
+        [x: string]: any;
+    };
+}>;
+export default sendServerToServerRequest;

package/dist/esm/types/types/ReactKitErrorCode.d.ts

@@ -15,6 +15,9 @@ declare enum ReactKitErrorCode {
     NotAdmin = "DRK10",
     NotAllowedToReviewLogs = "DRK11",
     ThemeCheckedBeforeReactKitReady = "DRK12",
-    SessionExpiredMessageGottenBeforeReactKitReady = "DRK13"
+    SessionExpiredMessageGottenBeforeReactKitReady = "DRK13",
+    NotConnected = "DRK14",
+    SelfSigned = "DRK15",
+    ResponseParseError = "DRK16"
 }
 export default ReactKitErrorCode;

package/dist/index.d.ts

@@ -1620,7 +1620,10 @@ declare enum ReactKitErrorCode {
     NotAdmin = "DRK10",
     NotAllowedToReviewLogs = "DRK11",
     ThemeCheckedBeforeReactKitReady = "DRK12",
-    SessionExpiredMessageGottenBeforeReactKitReady = "DRK13"
+    SessionExpiredMessageGottenBeforeReactKitReady = "DRK13",
+    NotConnected = "DRK14",
+    SelfSigned = "DRK15",
+    ResponseParseError = "DRK16"
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.8.6",
+  "version": "3.8.7",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -24,6 +24,7 @@
   },
   "homepage": "https://github.com/harvard-edtech/dce-reactkit#readme",
   "dependencies": {
+    "qs": "^6.x.x",
     "react-select": "^5.7.3"
   },
   "peerDependencies": {

package/src/helpers/visitEndpointOnAnotherServer/index.ts

@@ -0,0 +1,90 @@
+// Import custom error
+import ErrorWithCode from '../../errors/ErrorWithCode';
+
+// Import shared types
+import ReactKitErrorCode from '../../types/ReactKitErrorCode';
+
+// Import other helpers
+import sendServerToServerRequest from './sendServerToServerRequest';
+
+/**
+ * Send a server-to-server request from this sever to another server that uses
+ *   dce-reactkit [for server only]
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.path - the path of the other server's endpoint
+ * @param [opts.method=GET] - the method of the endpoint
+ * @param [opts.params] - query/body parameters to include
+ * @param [opts.headers] - headers to include
+ * @returns response from server
+ */
+const visitEndpointOnAnotherServer = async (
+  opts: {
+    path: string,
+    method?: ('GET' | 'POST' | 'DELETE' | 'PUT'),
+    params?: { [key in string]: any },
+    headers?: { [k in string]: any },
+  },
+): Promise<any> => {
+  // Remove properties with undefined values
+  let params: { [key in string]: any } | undefined;
+  if (opts.params) {
+    params = Object.fromEntries(
+      Object
+        .entries(opts.params)
+        .filter(([, value]) => {
+          return value !== undefined;
+        }),
+    );
+  }
+
+  // Automatically JSONify arrays and objects
+  if (params) {
+    params = Object.fromEntries(
+      Object
+        .entries(params)
+        .map(([key, value]) => {
+          if (Array.isArray(value) || typeof value === 'object') {
+            return [key, JSON.stringify(value)];
+          }
+          return [key, value];
+        }),
+    );
+  }
+
+  // Send the request
+  const response = await sendServerToServerRequest({
+    path: opts.path,
+    method: opts.method ?? 'GET',
+    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 visitEndpointOnAnotherServer;

package/src/helpers/visitEndpointOnAnotherServer/sendServerToServerRequest.ts

@@ -0,0 +1,164 @@
+// Import libs
+import qs from 'qs';
+
+// Import shared types
+import ReactKitErrorCode from '../../types/ReactKitErrorCode';
+
+// Import custom error
+import ErrorWithCode from '../../errors/ErrorWithCode';
+
+/**
+ * Sends and retries an http request
+ * @author Gabriel Abrams
+ * @param opts object containing all arguments
+ * @param opts.path path to send request to
+ * @param [opts.host] host to send request to
+ * @param [opts.method=GET] http method to use
+ * @param [opts.params] body/data to include in the request
+ * @param [opts.headers] headers to include in the request
+ * @param [opts.sendCrossDomainCredentials=true if in development mode] if true,
+ *   send cross-domain credentials even if not in dev mode
+ * @param [opts.responseType=JSON] expected response type
+ * @returns { body, status, headers } on success
+ */
+const sendServerToServerRequest = async (
+  opts: {
+    path: string,
+    host?: string,
+    method?: ('GET' | 'POST' | 'PUT' | 'DELETE'),
+    params?: { [k in string]: any },
+    headers?: { [k in string]: any },
+    responseType?: 'Text' | 'JSON',
+  },
+): Promise<{
+  body: any,
+  status: number,
+  headers: { [k in string]: any },
+}> => {
+  // Process method
+  const method: ('GET' | 'POST' | 'PUT' | 'DELETE') = (opts.method || 'GET');
+
+  // Encode objects within params
+  let params: {
+    [k in string]: any
+  } | undefined;
+  if (opts.params) {
+    params = {};
+    Object.entries(opts.params).forEach(([key, val]) => {
+      if (typeof val === 'object' && !Array.isArray(val)) {
+        (params as any)[key] = JSON.stringify(val);
+      } else {
+        (params as any)[key] = val;
+      }
+    });
+  }
+
+  // Stringify parameters
+  const stringifiedParams = qs.stringify(params || {}, {
+    encodeValuesOnly: true,
+    arrayFormat: 'brackets',
+  });
+
+  // Create url (include query if GET)
+  const query = (method === 'GET' ? `?${stringifiedParams}` : '');
+  let url;
+  if (!opts.host) {
+    // No host included at all. Just send to a path
+    url = `${opts.path}${query}`;
+  } else {
+    url = `https://${opts.host}${opts.path}${query}`;
+  }
+
+  // Update headers
+  const headers = opts.headers || {};
+  let data: string | null | { [k: string]: any } | undefined = null;
+  if (!headers['Content-Type']) {
+    // Form encoded
+    headers['Content-Type'] = 'application/x-www-form-urlencoded';
+    // Add data if applicable
+    data = (method !== 'GET' ? stringifiedParams : null);
+  } else {
+    // JSON encode
+    data = params;
+  }
+
+  // Encode data
+  let encodedData: URLSearchParams | string | undefined;
+  if (data) {
+    if (headers['Content-Type'] === 'application/x-www-form-urlencoded') {
+      encodedData = new URLSearchParams(params);
+    } else {
+      encodedData = JSON.stringify(data);
+    }
+  }
+
+  // Send request
+  try {
+    const response = await fetch(
+      url,
+      {
+        method,
+        mode: 'cors',
+        headers: headers ?? {},
+        body: (
+          (method !== 'GET' && encodedData)
+            ? encodedData
+            : undefined
+        ),
+        redirect: 'follow',
+      },
+    );
+
+    // Get headers map
+    const responseHeaders: {
+      [k in string]: string
+    } = {};
+    response.headers.forEach((value, key) => {
+      responseHeaders[key] = value;
+    });
+
+    // Process response based on responseType
+    try {
+      // Parse response
+      let responseBody: any;
+      if (
+        opts.responseType
+        && opts.responseType === 'Text'
+      ) {
+        // Response type is text
+        responseBody = await response.text();
+      } else {
+        // Response type is JSON
+        responseBody = await response.json();
+      }
+
+      // Return response
+      return {
+        body: responseBody,
+        status: response.status,
+        headers: responseHeaders,
+      };
+    } catch (err) {
+      throw new ErrorWithCode(
+        `Failed to parse response as ${opts.responseType}: ${(err as any)?.message}`,
+        ReactKitErrorCode.ResponseParseError,
+      );
+    }
+  } catch (err) {
+    // Self-signed certificate error:
+    if ((err as any)?.message?.includes('self signed certificate')) {
+      throw new ErrorWithCode(
+        'We refused to send a request because the receiver has self-signed certificates.',
+        ReactKitErrorCode.SelfSigned,
+      );
+    }
+
+    // No tries left
+    throw new ErrorWithCode(
+      `We encountered an error when trying to send a network request. If this issue persists, contact an admin. Error: ${(err as any)?.message}`,
+      ReactKitErrorCode.NotConnected,
+    );
+  }
+};
+
+export default sendServerToServerRequest;

package/src/types/ReactKitErrorCode.tsx

@@ -1,4 +1,4 @@
-// Highest error code = DRK13
+// Highest error code = DRK16
 
 /**
  * List of error codes built into the react kit
@@ -18,6 +18,11 @@ enum ReactKitErrorCode {
   NotAllowedToReviewLogs = 'DRK11',
   ThemeCheckedBeforeReactKitReady = 'DRK12',
   SessionExpiredMessageGottenBeforeReactKitReady = 'DRK13',
+
+  // Server-to-server requests
+  NotConnected = 'DRK14',
+  SelfSigned = 'DRK15',
+  ResponseParseError = 'DRK16',
 }
 
 export default ReactKitErrorCode;