dce-expresskit 4.0.0-beta-logreviewer.1

package/src/helpers/parseUserAgent.ts

@@ -0,0 +1,108 @@
+/**
+ * Perform a rudimentary parsing of the user's browser agent string
+ * @author Gabe Abrams
+ * @param userAgent the user's browser agent
+ * @returns user info
+ */
+const parseUserAgent = (userAgent: string) => {
+  /* ------------- Browser ------------ */
+
+  let browser: { name: string, version: string } = {
+    name: 'Unknown',
+    version: 'Unknown',
+  };
+
+  // Parse user agent
+  let verOffset: number;
+  let nameOffset: number;
+  if ((verOffset = userAgent.indexOf('Opera')) !== -1) {
+    // In Opera, the true version is after 'Opera' or after 'Version'
+    browser = {
+      name: 'Opera',
+      version: userAgent.substring(verOffset + 6),
+    };
+    if ((verOffset = userAgent.indexOf('Version')) !== -1) {
+      browser.version = userAgent.substring(verOffset + 8);
+    }
+  } else if ((verOffset = userAgent.indexOf('MSIE')) !== -1) {
+    // In MSIE, the true version is after 'MSIE' in userAgent
+    browser = {
+      name: 'Internet Explorer',
+      version: userAgent.substring(verOffset + 5),
+    };
+  } else if ((verOffset = userAgent.indexOf('Chrome')) !== -1) {
+    // In Chrome, the true version is after 'Chrome'
+    browser = {
+      name: 'Chrome',
+      version: userAgent.substring(verOffset + 7),
+    };
+  } else if ((verOffset = userAgent.indexOf('Safari')) !== -1) {
+    // In Safari, the true version is after 'Safari' or after 'Version'
+    browser = {
+      name: 'Safari',
+      version: userAgent.substring(verOffset + 7),
+    };
+    if ((verOffset = userAgent.indexOf('Version')) !== -1) {
+      browser.version = userAgent.substring(verOffset + 8);
+    }
+  } else if ((verOffset = userAgent.indexOf('Firefox')) != -1) {
+    // In Firefox, the true version is after 'Firefox'
+    browser = {
+      name: 'Firefox',
+      version: userAgent.substring(verOffset + 8),
+    };
+  } else if (
+    (nameOffset = userAgent.lastIndexOf(' ') + 1)
+    < (verOffset = userAgent.lastIndexOf('/'))
+  ) {
+    browser = {
+      name: userAgent.substring(nameOffset, verOffset),
+      version: userAgent.substring(verOffset + 1),
+    };
+  }
+
+  // Postprocess version
+  // trim the fullVersion string at semicolon/space if present
+  let ix: number;
+  if ((ix = browser.version.indexOf(';')) !== -1) {
+    browser.version = browser.version.substring(0, ix);
+  }
+  if ((ix = browser.version.indexOf(' ')) !== -1) {
+    browser.version = browser.version.substring(0, ix);
+  }
+
+  /* ------------- Device ------------- */
+
+  // Detect os
+  let os = 'Unknown';
+  if (userAgent.includes('Linux')) {
+    os = 'Linux';
+  } else if (userAgent.includes('like Mac')) {
+    os = 'iOS';
+  } else if (userAgent.includes('Mac')) {
+    os = 'Mac';
+  } else if (userAgent.includes('Android')) {
+    os = 'Android';
+  } else if (userAgent.includes('Win')) {
+    os = 'Win';
+  }
+
+  // Check if mobile
+  const isMobile = !!userAgent.match(/(iPhone|iPod|iPad|Android|BlackBerry)/);
+
+  // Device
+  const device = {
+    isMobile,
+    os,
+  };
+
+  /* ------------- Finish ------------- */
+
+  // Return info
+  return {
+    browser,
+    device,
+  };
+};
+
+export default parseUserAgent;

package/src/helpers/visitEndpointOnAnotherServer/index.ts

@@ -0,0 +1,70 @@
+// Import dce-reactkit
+import {
+  ErrorWithCode,
+  ReactKitErrorCode,
+} from 'dce-reactkit';
+
+// Import shared types
+import sendServerToServerRequest from './sendServerToServerRequest';
+
+/*------------------------------------------------------------------------*/
+/* -------------------------------- Main -------------------------------- */
+/*------------------------------------------------------------------------*/
+
+/**
+ * Visit an endpoint on another server
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.method the method of the endpoint
+ * @param opts.path the path of the other server's endpoint
+ * @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
+ */
+const visitEndpointOnAnotherServer = async (
+  opts: {
+    method: 'GET' | 'POST' | 'DELETE' | 'PUT',
+    path: string,
+    host: string,
+    params?: { [key in string]: any },
+    responseType?: 'JSON' | 'Text',
+  },
+): Promise<any> => {
+  // Send the request
+  const response = await sendServerToServerRequest({
+    path: opts.path,
+    host: opts.host,
+    method: opts.method,
+    params: opts.params,
+    responseType: opts.responseType,
+  });
+
+  // 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,
+    );
+  }
+  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,257 @@
+// Import libs
+import qs from 'qs';
+
+// Import dce-reactkit
+import {
+  ErrorWithCode,
+} from 'dce-reactkit';
+
+// Import data signer
+import { signRequest } from '../dataSigner';
+
+// Import shared types
+import ExpressKitErrorCode from '../../types/ExpressKitErrorCode';
+
+/*------------------------------------------------------------------------*/
+/* ----------------------------- Credentials ---------------------------- */
+/*------------------------------------------------------------------------*/
+
+/*
+DCEKIT_CROSS_SERVER_CREDENTIALS format:
+|host:key:secret||host:key:secret|...
+*/
+
+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,
+          );
+        }
+
+        // Return the credential
+        return {
+          host: parts[0].trim(),
+          key: parts[1].trim(),
+          secret: parts[2].trim(),
+        };
+      })
+  );
+
+/*------------------------------------------------------------------------*/
+/* ------------------------------- Helpers ------------------------------ */
+/*------------------------------------------------------------------------*/
+
+/**
+ * Get the credential to use for the request to another server
+ * @author Gabe Abrams
+ * @param host the host of the other server
+ * @return the credential to use
+ */
+const getCrossServerCredential = (host: string) => {
+  // Find the credential
+  const credential = credentials.find((cred) => {
+    return cred.host.toLowerCase() === host.toLowerCase();
+  });
+  if (!credential) {
+    throw new ErrorWithCode(
+      'Cannot send cross-server signed request there was no credential that matched the host that the request is being sent to.',
+      ExpressKitErrorCode.CrossServerNoCredentialsToSignWith,
+    );
+  }
+
+  // Return credential
+  return credential;
+};
+
+/*------------------------------------------------------------------------*/
+/* -------------------------------- Main -------------------------------- */
+/*------------------------------------------------------------------------*/
+
+/**
+ * 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.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 },
+    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;
+      }
+    });
+  }
+
+  // Get cross-server credential
+  const credential = getCrossServerCredential(opts.host);
+
+  // Sign the request, get new params
+  params = await signRequest({
+    method: opts.method,
+    path: opts.path,
+    params: params ?? {},
+    key: credential.key,
+    secret: credential.secret,
+  });
+
+  // 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: {
+    [k: string]: any,
+  } = {};
+  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}`,
+        ExpressKitErrorCode.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.',
+        ExpressKitErrorCode.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}`,
+      ExpressKitErrorCode.NotConnected,
+    );
+  }
+};
+
+export default sendServerToServerRequest;

package/src/html/genErrorPage.ts

@@ -0,0 +1,144 @@
+// Import dce-reactkit
+import { ReactKitErrorCode } from 'dce-reactkit';
+
+// Import shared types
+import ExpressKitErrorCode from '../types/ExpressKitErrorCode';
+
+/**
+ * Generate a static error page
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @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.pageTitle=opts.title] title of the page/tab if it differs from
+ *   the title of the error
+ * @returns html of the page
+ */
+const genErrorPage = (
+  opts: {
+    title?: string,
+    description?: string,
+    code?: string,
+    pageTitle?: string,
+  } = {},
+): string => {
+  const title = (opts.title ?? 'An Error Occurred');
+  const pageTitle = (opts.pageTitle ?? title);
+  const description = (
+    opts.description
+    ?? 'An unknown server error occurred. Please contact support.'
+  );
+  const code = (opts.code ?? ReactKitErrorCode.NoCode);
+
+  return `
+<head>
+  <!-- Metadata -->
+  <meta
+    name="viewport"
+    content="width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0"
+  >
+
+  <!-- Title -->
+  <title>${pageTitle}</title>
+
+  <!-- Bootstrap -->
+  <link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.1/css/bootstrap.min.css"
+    integrity="sha512-siwe/oXMhSjGCwLn+scraPOWrJxHlUgMBMZXdPe2Tnk3I0x3ESCoLz7WZ5NTH6SZrywMY+PB1cjyqJ5jAluCOg=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  />
+  <script
+    src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.1/js/bootstrap.min.js"
+    integrity="sha512-vyRAVI0IEm6LI/fVSv/Wq/d0KUfrg3hJq2Qz5FlfER69sf3ZHlOrsLriNm49FxnpUGmhx+TaJKwJ+ByTLKT+Yg=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  ></script>
+
+  <!-- FontAwesome -->
+  <link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css"
+    integrity="sha512-xh6O/CkQoPOWDdYTDqeRdPCVd1SpvCA9XXcUnZS2FmJNp1coAFzvtCN9BmamE+4aHK8yyUHUSCcJHgXloTyT2A=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  />
+
+  <!-- Style -->
+  <style>
+    .DCEReactKit-pop-in {
+      animation-name: DCEReactKit-pop-in;
+      animation-duration: 0.5s;
+      animation-iteration-count: 1;
+      animation-timing-function: ease-out;
+      animation-fill-mode: both;
+
+      transform-origin: center;
+    }
+
+    @keyframes DCEReactKit-pop-in {
+      0% {
+        opacity: 0;
+        transform: scale(0.9);
+      }
+      100% {
+        opacity: 1;
+        transform: scale(1);
+      }
+    }
+
+    .DCEReactKit-slide-in {
+      animation-name: DCEReactKit-slide-in;
+      animation-duration: 1s;
+      animation-iteration-count: 1;
+      animation-timing-function: ease-out;
+      animation-fill-mode: both;
+      animation-delay: 0.2s;
+    }
+
+    @keyframes DCEReactKit-slide-in {
+      0% {
+        opacity: 0;
+        transform: translate(0, 0.3em);
+      }
+      100% {
+        opacity: 1;
+        transform: translate(0, 0);
+      }
+    }
+  </style>
+</head>
+
+<!-- Body -->
+<body class="bg-dark text-center pt-3 ps-3 pe-3">
+  <!-- Alert -->
+  <div
+    class="DCEReactKit-pop-in alert alert-warning d-inline-block"
+    style="width: 50em; max-width: 100%"
+  >
+    <!-- Title -->
+    <h2>
+      <i class="me-1 fa-solid fa-triangle-exclamation"></i>
+      ${title}
+    </h2>
+    <!-- Description -->
+    <div>
+      ${description}
+    </div>
+  </div>
+
+  <!-- Error Code -->
+  <div class="DCEReactKit-slide-in text-light">
+    <strong>
+      Error Code:
+    </strong>
+    ${code}
+  </div>
+</body>
+  `;
+};
+
+export default genErrorPage;

package/src/html/genInfoPage.ts

@@ -0,0 +1,101 @@
+/**
+ * Generate a static info page
+ * @author Gabe Abrams
+ * @param opts object containing all arguments
+ * @param opts.title title of the info box
+ * @param opts.body a human-readable text body for the info alert
+ * @returns the HTML for the info page
+ */
+const genInfoPage = (
+  opts: {
+    title: string,
+    body: string,
+  },
+): string => {
+  const {
+    title,
+    body,
+  } = opts;
+
+  return `
+<head>
+  <!-- Metadata -->
+  <meta
+    name="viewport"
+    content="width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0"
+  >
+
+  <!-- Title -->
+  <title>${title}</title>
+
+  <!-- Bootstrap -->
+  <link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.1/css/bootstrap.min.css"
+    integrity="sha512-siwe/oXMhSjGCwLn+scraPOWrJxHlUgMBMZXdPe2Tnk3I0x3ESCoLz7WZ5NTH6SZrywMY+PB1cjyqJ5jAluCOg=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  />
+  <script
+    src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.1/js/bootstrap.min.js"
+    integrity="sha512-vyRAVI0IEm6LI/fVSv/Wq/d0KUfrg3hJq2Qz5FlfER69sf3ZHlOrsLriNm49FxnpUGmhx+TaJKwJ+ByTLKT+Yg=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  ></script>
+
+  <!-- FontAwesome -->
+  <link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css"
+    integrity="sha512-xh6O/CkQoPOWDdYTDqeRdPCVd1SpvCA9XXcUnZS2FmJNp1coAFzvtCN9BmamE+4aHK8yyUHUSCcJHgXloTyT2A=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  />
+
+  <!-- Style -->
+  <style>
+    .DCEReactKit-pop-in {
+      animation-name: DCEReactKit-pop-in;
+      animation-duration: 0.5s;
+      animation-iteration-count: 1;
+      animation-timing-function: ease-out;
+      animation-fill-mode: both;
+
+      transform-origin: center;
+    }
+
+    @keyframes DCEReactKit-pop-in {
+      0% {
+        opacity: 0;
+        transform: scale(0.9);
+      }
+      100% {
+        opacity: 1;
+        transform: scale(1);
+      }
+    }
+  </style>
+</head>
+
+<!-- Body -->
+<body class="bg-dark text-center pt-3 ps-3 pe-3">
+  <!-- Alert -->
+  <div
+    class="DCEReactKit-pop-in alert alert-info d-inline-block"
+    style="width: 50em; max-width: 100%"
+  >
+    <!-- Title -->
+    <h2>
+      <i class="me-1 fa-solid fa-circle-info"></i>
+      ${title}
+    </h2>
+    <!-- Body -->
+    <div>
+      ${body}
+    </div>
+  </div>
+</body>
+  `;
+};
+
+export default genInfoPage;