dce-reactkit 3.4.1 → 3.5.2

package/src/helpers/addDBEditorEndpoints.ts

@@ -0,0 +1,128 @@
+// Import express
+import express from 'express';
+
+// Import shared helpers
+import genRouteHandler from './genRouteHandler';
+import generateEndpointPath from '../components/DBEntryManagerPanel/helpers/generateEndpointPath';
+
+// Import shared types
+import ParamType from '../types/ParamType';
+
+/**
+ * Interface for a collection in the database
+ * @author Yuen Ler Chow
+ */
+type DCEMangoCollection = {
+  /**
+   * Find all items in the collection that match the filter query
+   * @param filterQuery 
+   * @returns list of items that match the filter query
+   */
+  find: (filterQuery: any) => Promise<any[]>,
+  /**
+   * Insert an item into the collection
+   * @param item the item to insert
+   */
+  insert: (item: any) => Promise<void>,
+  /**
+   * Delete an item in the collection
+   * @param id the id of the item to delete
+   */
+  delete: (filterQuery: { id: string }) => Promise<void>,
+};
+
+/**
+ * Add all routes for the DBEditor
+ * @author Yuen Ler Chow
+ * @param opts object containing all arguments
+ * @param opts.app express app to add routes too
+ * @param opts.collectionName the name of the collection
+ * @param opts.adminsOnly true if the endpoint is for admins only
+ * @param opts.collection dce-mango db collection
+ */
+const addDBEditorEndpoints = (
+  opts: {
+    app: express.Application,
+    collectionName: string,
+    adminsOnly: boolean,
+    collection: DCEMangoCollection,
+  },
+) => {
+  const {
+    app,
+    collectionName,
+    adminsOnly,
+    collection,
+  } = opts;
+
+  // Generate the endpoint path
+  const endpointPath = generateEndpointPath(collectionName, adminsOnly);
+
+  /**
+   * List all items in the collection
+   * @author Yuen Ler Chow
+   * @returns {any[]} the list of items in the collection
+   */
+  app.get(
+    endpointPath,
+    genRouteHandler({
+      paramTypes: {
+        filterQuery: ParamType.JSONOptional,
+      },
+      handler: async ({ params }) => {
+        const filterQuery = params.filterQuery ?? {};
+        const categories = await collection.find(filterQuery);
+        return categories;
+      },
+    }),
+  );
+
+  /**
+   * Create a new item in the collection
+   * @author Yuen Ler Chow
+   * @param {any} item the item to create
+   */
+  app.post(
+    endpointPath,
+    genRouteHandler({
+      paramTypes: {
+        item: ParamType.JSON,
+      },
+      handler: async ({
+        params,
+      }) => {
+        // Destructure params
+        const {
+          item,
+        } = params;
+
+        await collection.insert(item);
+      },
+    }),
+  );
+
+  /**
+   * Remove an item from the collection by id
+   * @author Yuen Ler Chow
+   */
+  app.delete(
+    `${endpointPath}/:id`,
+    genRouteHandler({
+      paramTypes: {
+        id: ParamType.String,
+      },
+      handler: async ({
+        params,
+      }) => {
+        // Destructure params
+        const {
+          id,
+        } = params;
+
+        await collection.delete({ id });
+      },
+    }),
+  );
+};
+
+export default addDBEditorEndpoints;

package/src/helpers/compareArraysByProp.ts

@@ -7,31 +7,53 @@ import extractProp from './extractProp';
  * @author Gabe Abrams
  * @param a the first array
  * @param b the second array
- * @param prop the property to compare with
+ * @param prop the property to compare with, or an array of props to compare
+ *   with (if array, all values associated with those props must match)
  * @returns true if the arrays contain the same objects as determined by
  *   the values associated with each object's prop
  */
-const compareArraysByProp = (a: any[], b: any[], prop: string): boolean => {
-  // Extract values for comparison
-  const aVals = new Set(extractProp(a, prop));
-  const bVals = new Set(extractProp(b, prop));
-
-  // Compare sizes first
-  if (aVals.size !== bVals.size) {
+const compareArraysByProp = (
+  a: any[],
+  b: any[],
+  prop: string | string[],
+): boolean => {
+  // Immediately return if size of arrays is different
+  if (a.length !== b.length) {
     return false;
   }
 
-  // Same number of items. Make sure every object in aVals appears in bVals
-  // (if so, they should be equivalent since the sizes are the same)
-  // > Create map of items in bVals
-  const inBVals: { [k: string]: boolean } = {}; // item => true if in bVals
-  Array.from(bVals.values()).forEach((item) => {
-    inBVals[item] = true;
-  });
-  // > Loop through aVals and make sure every item is in bVals
-  return Array.from(aVals.values()).every((item) => {
-    return inBVals[item];
-  });
+  // Get all props
+  const props = (Array.isArray(prop) ? prop : [prop]);
+
+  // Clone second array so we can work on it
+  const bCloned = [...b];
+
+  // Remove elements from b as we find them in a
+  for (let i = 0; i < a.length; i++) {
+    // Find matching element in b
+    const matchingIndex = bCloned.findIndex((bItem) => {
+      // Compare based on all props
+      return props.every((propToCompareBy) => {
+        const aVal = extractProp(a[i], propToCompareBy);
+        const bVal = extractProp(bItem, propToCompareBy);
+        return aVal === bVal;
+      });
+    });
+
+    // Check if no match
+    const noMatch = (matchingIndex < 0);
+
+    // If no match, there's no corresponding element in b
+    if (noMatch) {
+      return false;
+    }
+
+    // Remove the matching element
+    bCloned.splice(matchingIndex, 1);
+  }
+
+  // If we made it here, all elements in a have a corresponding element in b
+  return true;
 };
 
 export default compareArraysByProp;

package/src/index.ts

@@ -17,6 +17,7 @@ import ItemPicker from './components/ItemPicker';
 import LogReviewer from './components/LogReviewer';
 import IntelliTable from './components/IntelliTable';
 import CSVDownloadButton from './components/CSVDownloadButton';
+import DBEntryManagerPanel from './components/DBEntryManagerPanel';
 
 // Import errors
 import ErrorWithCode from './errors/ErrorWithCode';
@@ -63,11 +64,12 @@ import canReviewLogs from './helpers/canReviewLogs';
 import isMobileOrTablet from './helpers/isMobileOrTablet';
 import extractProp from './helpers/extractProp';
 import compareArraysByProp from './helpers/compareArraysByProp';
+import getLocalTimeInfo from './helpers/getLocalTimeInfo';
+import addDBEditorEndpoints from './helpers/addDBEditorEndpoints';
 import genCommaList from './helpers/genCommaList';
 import validateEmail from './helpers/validators/validateEmail';
 import validatePhoneNumber from './helpers/validators/validatePhoneNumber';
 import validateString from './helpers/validators/validateString';
-import getLocalTimeInfo from './helpers/getLocalTimeInfo';  
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -87,6 +89,9 @@ import IntelliTableColumn from './types/IntelliTableColumn';
 
 // Component-specific-types
 import PickableItem from './components/ItemPicker/types/PickableItem';
+import DBEntry from './components/DBEntryManagerPanel/types/DBEntry';
+import DBEntryField from './components/DBEntryManagerPanel/types/DBEntryField';
+import DBEntryFieldType from './components/DBEntryManagerPanel/types/DBEntryFieldType';
 
 // Export each item
 export {
@@ -109,6 +114,7 @@ export {
   LogReviewer,
   IntelliTable,
   CSVDownloadButton,
+  DBEntryManagerPanel,
   // Global functions
   alert,
   confirm,
@@ -162,6 +168,7 @@ export {
   handleError,
   handleSuccess,
   initLogCollection,
+  addDBEditorEndpoints,
   // Types
   ModalButtonType,
   ModalSize,
@@ -178,6 +185,9 @@ export {
   IntelliTableColumn,
   // Component-specific-types
   PickableItem,
+  DBEntry,
+  DBEntryField,
+  DBEntryFieldType,
   // Server types
   ParamType,
 };