dce-reactkit 3.3.6 → 3.4.0-beta.1

package/src/helpers/addDBEditorEndpoints.ts

@@ -0,0 +1,121 @@
+import express from 'express';
+
+// Import dce-reactkit
+import { genRouteHandler, ParamType } from 'dce-reactkit';
+import generateEndpointPath from '../components/DBEntryManagerPanel/helpers/generateEndpointPath';
+
+/**
+ * Interface for a collection in the database
+ * @author Yuen Ler Chow
+ */
+interface Collection {
+  /**
+   * 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
+ */
+const addDBEditorEndpoints = (opts: {
+  app: express.Application,
+  collectionName: string,
+  adminsOnly: boolean,
+  collection: Collection
+},
+) => {
+  const {
+    app,
+    collectionName,
+    adminsOnly,
+    collection,
+  } = opts;
+
+  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/index.ts

@@ -17,7 +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';
 
@@ -64,6 +64,7 @@ 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 types
 import ModalButtonType from './types/ModalButtonType';
@@ -83,6 +84,10 @@ 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 {
@@ -105,6 +110,7 @@ export {
   LogReviewer,
   IntelliTable,
   CSVDownloadButton,
+  DBEntryManagerPanel,
   // Global functions
   alert,
   confirm,
@@ -154,6 +160,7 @@ export {
   handleError,
   handleSuccess,
   initLogCollection,
+  addDBEditorEndpoints,
   // Types
   ModalButtonType,
   ModalSize,
@@ -170,6 +177,9 @@ export {
   IntelliTableColumn,
   // Component-specific-types
   PickableItem,
+  DBEntry,
+  DBEntryField,
+  DBEntryFieldType,
   // Server types
   ParamType,
 };