dce-expresskit 4.0.0-beta.10

package/lib/index.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParamType = exports.LogBuiltInMetadata = exports.LogAction = exports.LogSource = exports.LogType = exports.DayOfWeek = exports.visitEndpointOnAnotherServer = exports.addDBEditorEndpoints = exports.initCrossServerCredentialCollection = exports.initLogCollection = exports.handleSuccess = exports.handleError = exports.genRouteHandler = exports.initServer = exports.shuffleArray = exports.capitalize = exports.someAsync = exports.mapAsync = exports.forEachAsync = exports.filterAsync = exports.everyAsync = exports.prefixWithAOrAn = exports.getLocalTimeInfo = exports.genCommaList = exports.compareArraysByProp = exports.extractProp = exports.genCSV = exports.getMonthName = exports.parallelLimit = exports.onlyKeepLetters = exports.stringsToHumanReadableList = exports.getPartOfDay = exports.getHumanReadableDate = exports.startMinWait = exports.getTimeInfoInET = exports.getOrdinal = exports.waitMs = exports.sum = exports.roundToNumDecimals = exports.padZerosLeft = exports.padDecimalZeros = exports.forceNumIntoBounds = exports.floorToNumDecimals = exports.ceilToNumDecimals = exports.avg = exports.abbreviate = exports.DAY_IN_MS = exports.HOUR_IN_MS = exports.MINUTE_IN_MS = exports.ErrorWithCode = void 0;
+// Import dce-reactkit
+var dce_reactkit_1 = require("dce-reactkit");
+Object.defineProperty(exports, "abbreviate", { enumerable: true, get: function () { return dce_reactkit_1.abbreviate; } });
+Object.defineProperty(exports, "avg", { enumerable: true, get: function () { return dce_reactkit_1.avg; } });
+Object.defineProperty(exports, "ceilToNumDecimals", { enumerable: true, get: function () { return dce_reactkit_1.ceilToNumDecimals; } });
+Object.defineProperty(exports, "floorToNumDecimals", { enumerable: true, get: function () { return dce_reactkit_1.floorToNumDecimals; } });
+Object.defineProperty(exports, "forceNumIntoBounds", { enumerable: true, get: function () { return dce_reactkit_1.forceNumIntoBounds; } });
+Object.defineProperty(exports, "padDecimalZeros", { enumerable: true, get: function () { return dce_reactkit_1.padDecimalZeros; } });
+Object.defineProperty(exports, "padZerosLeft", { enumerable: true, get: function () { return dce_reactkit_1.padZerosLeft; } });
+Object.defineProperty(exports, "roundToNumDecimals", { enumerable: true, get: function () { return dce_reactkit_1.roundToNumDecimals; } });
+Object.defineProperty(exports, "sum", { enumerable: true, get: function () { return dce_reactkit_1.sum; } });
+Object.defineProperty(exports, "waitMs", { enumerable: true, get: function () { return dce_reactkit_1.waitMs; } });
+Object.defineProperty(exports, "getOrdinal", { enumerable: true, get: function () { return dce_reactkit_1.getOrdinal; } });
+Object.defineProperty(exports, "getTimeInfoInET", { enumerable: true, get: function () { return dce_reactkit_1.getTimeInfoInET; } });
+Object.defineProperty(exports, "startMinWait", { enumerable: true, get: function () { return dce_reactkit_1.startMinWait; } });
+Object.defineProperty(exports, "getHumanReadableDate", { enumerable: true, get: function () { return dce_reactkit_1.getHumanReadableDate; } });
+Object.defineProperty(exports, "getPartOfDay", { enumerable: true, get: function () { return dce_reactkit_1.getPartOfDay; } });
+Object.defineProperty(exports, "stringsToHumanReadableList", { enumerable: true, get: function () { return dce_reactkit_1.stringsToHumanReadableList; } });
+Object.defineProperty(exports, "onlyKeepLetters", { enumerable: true, get: function () { return dce_reactkit_1.onlyKeepLetters; } });
+Object.defineProperty(exports, "parallelLimit", { enumerable: true, get: function () { return dce_reactkit_1.parallelLimit; } });
+Object.defineProperty(exports, "getMonthName", { enumerable: true, get: function () { return dce_reactkit_1.getMonthName; } });
+Object.defineProperty(exports, "genCSV", { enumerable: true, get: function () { return dce_reactkit_1.genCSV; } });
+Object.defineProperty(exports, "extractProp", { enumerable: true, get: function () { return dce_reactkit_1.extractProp; } });
+Object.defineProperty(exports, "compareArraysByProp", { enumerable: true, get: function () { return dce_reactkit_1.compareArraysByProp; } });
+Object.defineProperty(exports, "getLocalTimeInfo", { enumerable: true, get: function () { return dce_reactkit_1.getLocalTimeInfo; } });
+Object.defineProperty(exports, "genCommaList", { enumerable: true, get: function () { return dce_reactkit_1.genCommaList; } });
+Object.defineProperty(exports, "prefixWithAOrAn", { enumerable: true, get: function () { return dce_reactkit_1.prefixWithAOrAn; } });
+Object.defineProperty(exports, "everyAsync", { enumerable: true, get: function () { return dce_reactkit_1.everyAsync; } });
+Object.defineProperty(exports, "filterAsync", { enumerable: true, get: function () { return dce_reactkit_1.filterAsync; } });
+Object.defineProperty(exports, "forEachAsync", { enumerable: true, get: function () { return dce_reactkit_1.forEachAsync; } });
+Object.defineProperty(exports, "mapAsync", { enumerable: true, get: function () { return dce_reactkit_1.mapAsync; } });
+Object.defineProperty(exports, "someAsync", { enumerable: true, get: function () { return dce_reactkit_1.someAsync; } });
+Object.defineProperty(exports, "capitalize", { enumerable: true, get: function () { return dce_reactkit_1.capitalize; } });
+Object.defineProperty(exports, "shuffleArray", { enumerable: true, get: function () { return dce_reactkit_1.shuffleArray; } });
+Object.defineProperty(exports, "DayOfWeek", { enumerable: true, get: function () { return dce_reactkit_1.DayOfWeek; } });
+Object.defineProperty(exports, "LogType", { enumerable: true, get: function () { return dce_reactkit_1.LogType; } });
+Object.defineProperty(exports, "LogSource", { enumerable: true, get: function () { return dce_reactkit_1.LogSource; } });
+Object.defineProperty(exports, "LogAction", { enumerable: true, get: function () { return dce_reactkit_1.LogAction; } });
+Object.defineProperty(exports, "LogBuiltInMetadata", { enumerable: true, get: function () { return dce_reactkit_1.LogBuiltInMetadata; } });
+Object.defineProperty(exports, "MINUTE_IN_MS", { enumerable: true, get: function () { return dce_reactkit_1.MINUTE_IN_MS; } });
+Object.defineProperty(exports, "HOUR_IN_MS", { enumerable: true, get: function () { return dce_reactkit_1.HOUR_IN_MS; } });
+Object.defineProperty(exports, "DAY_IN_MS", { enumerable: true, get: function () { return dce_reactkit_1.DAY_IN_MS; } });
+Object.defineProperty(exports, "ErrorWithCode", { enumerable: true, get: function () { return dce_reactkit_1.ErrorWithCode; } });
+Object.defineProperty(exports, "ParamType", { enumerable: true, get: function () { return dce_reactkit_1.ParamType; } });
+// Import helpers
+var initCrossServerCredentialCollection_1 = __importDefault(require("./helpers/initCrossServerCredentialCollection"));
+exports.initCrossServerCredentialCollection = initCrossServerCredentialCollection_1.default;
+var initLogCollection_1 = __importDefault(require("./helpers/initLogCollection"));
+exports.initLogCollection = initLogCollection_1.default;
+var initServer_1 = __importDefault(require("./helpers/initServer"));
+exports.initServer = initServer_1.default;
+var genRouteHandler_1 = __importDefault(require("./helpers/genRouteHandler"));
+exports.genRouteHandler = genRouteHandler_1.default;
+var handleError_1 = __importDefault(require("./helpers/handleError"));
+exports.handleError = handleError_1.default;
+var handleSuccess_1 = __importDefault(require("./helpers/handleSuccess"));
+exports.handleSuccess = handleSuccess_1.default;
+var addDBEditorEndpoints_1 = __importDefault(require("./helpers/addDBEditorEndpoints"));
+exports.addDBEditorEndpoints = addDBEditorEndpoints_1.default;
+var visitEndpointOnAnotherServer_1 = __importDefault(require("./helpers/visitEndpointOnAnotherServer"));
+exports.visitEndpointOnAnotherServer = visitEndpointOnAnotherServer_1.default;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sBAAsB;AACtB,6CA8CsB;AAwBpB,2FArEA,yBAAU,OAqEA;AACV,oFArEA,kBAAG,OAqEA;AACH,kGArEA,gCAAiB,OAqEA;AACjB,mGArEA,iCAAkB,OAqEA;AAClB,mGArEA,iCAAkB,OAqEA;AAClB,gGArEA,8BAAe,OAqEA;AACf,6FArEA,2BAAY,OAqEA;AACZ,mGArEA,iCAAkB,OAqEA;AAClB,oFArEA,kBAAG,OAqEA;AACH,uFArEA,qBAAM,OAqEA;AACN,2FArEA,yBAAU,OAqEA;AACV,gGArEA,8BAAe,OAqEA;AACf,6FArEA,2BAAY,OAqEA;AACZ,qGArEA,mCAAoB,OAqEA;AACpB,6FArEA,2BAAY,OAqEA;AACZ,2GArEA,yCAA0B,OAqEA;AAC1B,gGArEA,8BAAe,OAqEA;AACf,8FArEA,4BAAa,OAqEA;AACb,6FArEA,2BAAY,OAqEA;AACZ,uFArEA,qBAAM,OAqEA;AACN,4FArEA,0BAAW,OAqEA;AACX,oGArEA,kCAAmB,OAqEA;AAEnB,iGAtEA,+BAAgB,OAsEA;AADhB,6FApEA,2BAAY,OAoEA;AAEZ,gGArEA,8BAAe,OAqEA;AACf,2FArEA,yBAAU,OAqEA;AACV,4FArEA,0BAAW,OAqEA;AACX,6FArEA,2BAAY,OAqEA;AACZ,yFArEA,uBAAQ,OAqEA;AACR,0FArEA,wBAAS,OAqEA;AACT,2FArEA,yBAAU,OAqEA;AACV,6FArEA,2BAAY,OAqEA;AAWZ,0FA/EA,wBAAS,OA+EA;AAET,wFA/EA,sBAAO,OA+EA;AACP,0FA/EA,wBAAS,OA+EA;AACT,0FA/EA,wBAAS,OA+EA;AACT,mGA/EA,iCAAkB,OA+EA;AAnDlB,6FAzBA,2BAAY,OAyBA;AACZ,2FAzBA,yBAAU,OAyBA;AACV,0FAzBA,wBAAS,OAyBA;AAJT,8FApBA,4BAAa,OAoBA;AA0Db,0FA7EA,wBAAS,OA6EA;AA1EX,iBAAiB;AACjB,sHAAgG;AA2D9F,8CA3DK,6CAAmC,CA2DL;AA1DrC,kFAA4D;AAyD1D,4BAzDK,2BAAiB,CAyDL;AAxDnB,oEAA8C;AAoD5C,qBApDK,oBAAU,CAoDL;AAnDZ,8EAAwD;AAoDtD,0BApDK,yBAAe,CAoDL;AAnDjB,sEAAgD;AAoD9C,sBApDK,qBAAW,CAoDL;AAnDb,0EAAoD;AAoDlD,wBApDK,uBAAa,CAoDL;AAnDf,wFAAkE;AAsDhE,+BAtDK,8BAAoB,CAsDL;AArDtB,wGAAkF;AAsDhF,uCAtDK,sCAA4B,CAsDL"}

package/lib/types/CrossServerCredential.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Single cross-server credential
+ * @author Gabe Abrams
+ */
+type CrossServerCredential = {
+    description: string;
+    key: string;
+    encodedeSecret: string;
+    scopes: string[];
+};
+export default CrossServerCredential;

package/lib/types/CrossServerCredential.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CrossServerCredential.js.map

package/lib/types/CrossServerCredential.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrossServerCredential.js","sourceRoot":"","sources":["../../src/types/CrossServerCredential.ts"],"names":[],"mappings":""}

package/lib/types/ExpressKitErrorCode.d.ts

@@ -0,0 +1,31 @@
+/**
+ * List of error codes built into the express kit
+ * @author Gabe Abrams
+ */
+declare enum ExpressKitErrorCode {
+    WrongCourse = "DEK6",
+    NotTTM = "DEK9",
+    NotAdmin = "DEK10",
+    NotAllowedToReviewLogs = "DEK11",
+    ThemeCheckedBeforeReactKitReady = "DEK12",
+    InvalidParameter = "DEK5",
+    MissingParameter = "DEK4",
+    NotConnected = "DEK14",
+    SelfSigned = "DEK15",
+    ResponseParseError = "DEK16",
+    SignedRequestUnparseable = "DEK28",
+    SignedRequestInvalidCollection = "DEK21",
+    SignedRequestInvalidCredential = "DEK23",
+    SignedRequestInvalidScope = "DEK22",
+    SignedRequestInvalidTimestamp = "DEK24",
+    SignedRequestInvalidSignature = "DEK25",
+    SignedRequestInvalidBody = "DEK26",
+    CrossServerNoCredentialsToSignWith = "DEK27",
+    CrossServerMissingSignedRequestInfo = "DEK29",
+    CrossServerNoCredentialEncodingSalt = "DEK30",
+    NoOauthLib = "DEK31",
+    NoCryptoLib = "DEK32",
+    InvalidCrossServerCredentialsFormat = "DEK33",
+    UnknownCrossServerError = "DEK34"
+}
+export default ExpressKitErrorCode;

package/lib/types/ExpressKitErrorCode.js

@@ -0,0 +1,38 @@
+"use strict";
+// Highest error code = DEK34
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * List of error codes built into the express kit
+ * @author Gabe Abrams
+ */
+var ExpressKitErrorCode;
+(function (ExpressKitErrorCode) {
+    // General errors
+    ExpressKitErrorCode["WrongCourse"] = "DEK6";
+    ExpressKitErrorCode["NotTTM"] = "DEK9";
+    ExpressKitErrorCode["NotAdmin"] = "DEK10";
+    ExpressKitErrorCode["NotAllowedToReviewLogs"] = "DEK11";
+    ExpressKitErrorCode["ThemeCheckedBeforeReactKitReady"] = "DEK12";
+    ExpressKitErrorCode["InvalidParameter"] = "DEK5";
+    ExpressKitErrorCode["MissingParameter"] = "DEK4";
+    // Server-to-server requests
+    ExpressKitErrorCode["NotConnected"] = "DEK14";
+    ExpressKitErrorCode["SelfSigned"] = "DEK15";
+    ExpressKitErrorCode["ResponseParseError"] = "DEK16";
+    ExpressKitErrorCode["SignedRequestUnparseable"] = "DEK28";
+    ExpressKitErrorCode["SignedRequestInvalidCollection"] = "DEK21";
+    ExpressKitErrorCode["SignedRequestInvalidCredential"] = "DEK23";
+    ExpressKitErrorCode["SignedRequestInvalidScope"] = "DEK22";
+    ExpressKitErrorCode["SignedRequestInvalidTimestamp"] = "DEK24";
+    ExpressKitErrorCode["SignedRequestInvalidSignature"] = "DEK25";
+    ExpressKitErrorCode["SignedRequestInvalidBody"] = "DEK26";
+    ExpressKitErrorCode["CrossServerNoCredentialsToSignWith"] = "DEK27";
+    ExpressKitErrorCode["CrossServerMissingSignedRequestInfo"] = "DEK29";
+    ExpressKitErrorCode["CrossServerNoCredentialEncodingSalt"] = "DEK30";
+    ExpressKitErrorCode["NoOauthLib"] = "DEK31";
+    ExpressKitErrorCode["NoCryptoLib"] = "DEK32";
+    ExpressKitErrorCode["InvalidCrossServerCredentialsFormat"] = "DEK33";
+    ExpressKitErrorCode["UnknownCrossServerError"] = "DEK34";
+})(ExpressKitErrorCode || (ExpressKitErrorCode = {}));
+exports.default = ExpressKitErrorCode;
+//# sourceMappingURL=ExpressKitErrorCode.js.map

package/lib/types/ExpressKitErrorCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressKitErrorCode.js","sourceRoot":"","sources":["../../src/types/ExpressKitErrorCode.ts"],"names":[],"mappings":";AAAA,6BAA6B;;AAE7B;;;GAGG;AACH,IAAK,mBA4BJ;AA5BD,WAAK,mBAAmB;IACtB,iBAAiB;IACjB,2CAAoB,CAAA;IACpB,sCAAe,CAAA;IACf,yCAAkB,CAAA;IAClB,uDAAgC,CAAA;IAChC,gEAAyC,CAAA;IACzC,gDAAyB,CAAA;IACzB,gDAAyB,CAAA;IAEzB,4BAA4B;IAC5B,6CAAsB,CAAA;IACtB,2CAAoB,CAAA;IACpB,mDAA4B,CAAA;IAC5B,yDAAkC,CAAA;IAClC,+DAAwC,CAAA;IACxC,+DAAwC,CAAA;IACxC,0DAAmC,CAAA;IACnC,8DAAuC,CAAA;IACvC,8DAAuC,CAAA;IACvC,yDAAkC,CAAA;IAClC,mEAA4C,CAAA;IAC5C,oEAA6C,CAAA;IAC7C,oEAA6C,CAAA;IAC7C,2CAAoB,CAAA;IACpB,4CAAqB,CAAA;IACrB,oEAA6C,CAAA;IAC7C,wDAAiC,CAAA;AACnC,CAAC,EA5BI,mBAAmB,KAAnB,mBAAmB,QA4BvB;AAED,kBAAe,mBAAmB,CAAC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "dce-expresskit",
+  "version": "4.0.0-beta.10",
+  "description": "Shared functions, helpers, and tools for Harvard DCE Express-based servers",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "tsc --project ./tsconfig.json",
+    "gen-cross-server-secret": "npx tsx genEncodedSecret.ts",
+    "gen-cross-server-salt": "npx tsx genSalt.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harvard-edtech/dce-expresskit.git"
+  },
+  "keywords": [
+    "Express",
+    "Harvard",
+    "DCE",
+    "Toolkit"
+  ],
+  "dependencies": {
+    "@fortawesome/fontawesome-svg-core": "^6.7.2",
+    "@fortawesome/free-regular-svg-icons": "^6.7.2",
+    "@fortawesome/free-solid-svg-icons": "^6.7.2",
+    "@fortawesome/react-fontawesome": "^0.2.2",
+    "bootstrap": "^5.3.3",
+    "dce-reactkit": "^4.0.0-beta.2",
+    "react": "^19.0.0"
+  },
+  "peerDependencies": {
+    "caccl": "^x.x.x",
+    "dce-mango": "^x.x.x",
+    "express": "^4.21.2",
+    "express-session": "^1.18.1"
+  },
+  "author": "Gabe Abrams <gabeabrams@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/harvard-edtech/dce-expresskit/issues"
+  },
+  "homepage": "https://github.com/harvard-edtech/dce-expresskit#readme",
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/express-session": "^1.18.1",
+    "@types/node": "^22.13.10",
+    "@types/oauth-signature": "^1.5.2",
+    "@typescript-eslint/eslint-plugin": "^5.59.9",
+    "@typescript-eslint/parser": "^5.59.9",
+    "eslint": "^8.42.0",
+    "typescript": "^5.8.2"
+  }
+}

package/src/constants/LOG_REVIEW_ROUTE_PATH_PREFIX.ts

@@ -0,0 +1,9 @@
+import ROUTE_PATH_PREFIX from './ROUTE_PATH_PREFIX';
+
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+const LOG_REVIEW_ROUTE_PATH_PREFIX = `/admin${ROUTE_PATH_PREFIX}/logs`;
+
+export default LOG_REVIEW_ROUTE_PATH_PREFIX;

package/src/constants/LOG_REVIEW_STATUS_ROUTE.ts

@@ -0,0 +1,10 @@
+import ROUTE_PATH_PREFIX from './ROUTE_PATH_PREFIX';
+
+/**
+ * Route for checking the status of the current user's
+ *   access to log review
+ * @author Gabe Abrams
+ */
+const LOG_REVIEW_STATUS_ROUTE = `${ROUTE_PATH_PREFIX}/logs/access_allowed`;
+
+export default LOG_REVIEW_STATUS_ROUTE;

package/src/constants/LOG_ROUTE_PATH.ts

@@ -0,0 +1,9 @@
+import ROUTE_PATH_PREFIX from './ROUTE_PATH_PREFIX';
+
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+const LOG_ROUTE_PATH = `${ROUTE_PATH_PREFIX}/log`;
+
+export default LOG_ROUTE_PATH;

package/src/constants/ROUTE_PATH_PREFIX.ts

@@ -0,0 +1,7 @@
+/**
+ * Path that all routes start with
+ * @author Gabe Abrams
+ */
+const ROUTE_PATH_PREFIX = '/dce-expresskit';
+
+export default ROUTE_PATH_PREFIX;

package/src/errors/ErrorWithCode.tsx

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

package/src/helpers/addDBEditorEndpoints/generateEndpointPath.ts

@@ -0,0 +1,16 @@
+/**
+ * Generates the endpoint path for the given collection name
+ * @author Yuen Ler Chow
+ * @param collectionName the name of the collection
+ * @param [adminsOnly] true if the endpoint is for admins only
+ * @returns the endpoint path
+ */
+const generateEndpointPath = (collectionName: string, adminsOnly?: boolean) => {
+  // Determine prefix based on whether the endpoint is for admins only
+  const userPath = adminsOnly ? 'admin' : 'ttm';
+
+  // Return the endpoint path
+  return `/api/${userPath}/dce-reactkit/dbeditor/${collectionName}`;
+};
+
+export default generateEndpointPath;

package/src/helpers/addDBEditorEndpoints/index.ts

@@ -0,0 +1,130 @@
+// Import express
+import express from 'express';
+
+// Import dce-reactkit
+import {
+  ParamType,
+} from 'dce-reactkit';
+
+// Import shared helpers
+import genRouteHandler from '../genRouteHandler';
+import generateEndpointPath from './generateEndpointPath';
+
+/**
+ * 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 query for the filter
+   * @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;