dce-expresskit 4.0.0-beta-logreviewer.1

package/.eslintrc.js

@@ -0,0 +1,93 @@
+const config = {
+  extends: [
+    'airbnb',
+    'airbnb/hooks',
+  ],
+  overrides: [
+    {
+      files: [
+        '*.ts',
+        '*.tsx',
+      ],
+      extends: [
+        'airbnb-typescript',
+      ],
+      parserOptions: {
+        project: './tsconfig.json',
+        tsconfigRootDir: __dirname,
+        sourceType: 'module',
+      },
+      rules: {
+        '@typescript-eslint/lines-between-class-members': 'off',
+        '@typescript-eslint/no-unused-expressions': 'off',
+      },
+    },
+  ],
+  rules: {
+    'arrow-body-style': [
+      'warn',
+      'always',
+    ],
+    'react/prop-types': 'off',
+    'react/function-component-definition': [
+      2,
+      {
+        namedComponents: 'arrow-function',
+      },
+    ],
+    'no-spaced-func': 'off',
+    'react-hooks/exhaustive-deps': 'off',
+    'lines-between-class-members': 'off',
+    'no-case-declarations': 'off',
+    'react/require-default-props': 'off',
+    'react/react-in-jsx-scope': 'off',
+    'arrow-parens': [
+      'warn',
+      'always',
+    ],
+    'comma-dangle': [
+      'error',
+      {
+        arrays: 'always-multiline',
+        objects: 'always-multiline',
+        imports: 'always-multiline',
+        exports: 'always-multiline',
+        functions: 'always-multiline',
+      },
+    ],
+    'consistent-return': 'off',
+    'id-length': 'off',
+    'max-len': [
+      'error',
+      {
+        code: 125,
+        ignoreStrings: true,
+        ignoreTemplateLiterals: true,
+        ignoreUrls: true,
+      },
+    ],
+    'newline-per-chained-call': [
+      'error',
+      {
+        ignoreChainWithDepth: 2,
+      },
+    ],
+    'no-plusplus': [
+      'warn',
+      {
+        allowForLoopAfterthoughts: true,
+      },
+    ],
+    'prefer-template': 1,
+    radix: 'error',
+    'no-await-in-loop': 'off',
+    'max-params': [
+      'warn',
+      {
+        max: 3,
+      },
+    ],
+  },
+};
+
+module.exports = config;

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Harvard Edtech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# dce-expresskit
+
+Shared functions, helpers, and tools for Harvard DCE Express-based servers
+
+## Quickstart
+
+1. Install `dce-expresskit` into your React project:
+
+```bash
+npm install dce-expresskit --save
+```
+
+2. Import `dce-expresskit` components into your React component:
+
+```js
+import { genRouteHandler } from 'dce-expresskit';
+```

package/genEncodedSecret.ts

@@ -0,0 +1,107 @@
+// Import crypto lib
+import crypto from 'crypto';
+
+// Prompt
+import readline from 'readline';
+
+// Create a readline interface
+const readlineInterface = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+/**
+ * Prompt user for input
+ * @author Gabe Abrams
+ * @param question the question to ask the user
+ * @returns the text from the user
+ */
+const prompt = (question: string): Promise<string> => {
+  return new Promise((resolve, reject) => {
+    readlineInterface.question(question, (answer: string) => {
+      if (!answer || answer.trim().length === 0) {
+        console.log('\nValue cannot be empty. Exiting...');
+        process.exit(0);
+      }
+
+      resolve(answer);
+    });
+  });
+};
+
+// All chars for randomizer
+const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+
+(async () => {
+  console.log('––––– Generate Encoded Secret –––––');
+  console.log('\nFirst, we need info on the *receiving* server');
+  console.log('This is the server that hosts the cross-server endpoint, the one that receives requests from the sending server.\n');
+
+  // Get salt
+  console.log('Encoding salt on the *receiving* server')
+  const salt = await prompt('Salt: ');
+
+  // Get host
+  console.log('Hostname of the *receiving* server');
+  const host = await prompt('Host: ');
+
+  console.log('\n\nSecond, we need info on the *sending* server');
+  console.log('This is the server that sends requests to the receiving server.\n');
+
+  // Get key
+  console.log('Short unique key for the *sending* server (only letters and dashes, no whitespace)')
+  const key = (await prompt('Key: ')).trim();
+
+  // Get description
+  console.log('Human-readable description of the *sending* server')
+  const description = await prompt('Description: ');
+
+  // Generate a random secret
+  let secret = '';
+  for (let i = 0; i < 32; i++) {
+    secret += chars.charAt(Math.floor(Math.random() * chars.length));
+  }
+  secret = Buffer.from(secret).toString('base64');
+
+  // Encryption process based on:
+  // https://medium.com/@tony.infisical/guide-to-nodes-crypto-module-for-encryption-decryption-65c077176980
+
+  // Create a random initialization vector
+  const iv = crypto.randomBytes(12).toString('base64');
+
+  // Create a cipher
+  console.log('salt', salt, Buffer.from(salt, 'base64'));
+  const cipher = crypto.createCipheriv(
+    'aes-256-gcm',
+    Buffer.from(salt, 'base64'),
+    Buffer.from(iv, 'base64'),
+  );
+
+  // Encrypt the string
+  let ciphertext = cipher.update(secret, 'utf8', 'base64');
+
+  // Finalize the encryption
+  ciphertext += cipher.final('base64');
+
+  // Get the authentication tag
+  const tag = cipher.getAuthTag();
+
+  // JSONify the encrypted data
+  const encryptionPack = encodeURIComponent(JSON.stringify({
+    ciphertext,
+    iv,
+    tag,
+  }));
+
+  // Show the encrypted data
+  console.log('\n\n');
+  console.log('––––– Done! What\'s Next: –––––');
+  console.log('');
+  console.log('On the *sending* server, !!APPEND!! the following to the DCEKIT_CROSS_SERVER_CREDENTIALS env var:');
+  console.log(`|${host}:${key}:${secret}|`);
+  console.log('');
+  console.log('On the *receiving* server, add an entry to its "CrossServerCredential" collection:');
+  console.log(`{ "description": "${description}", "key": "${key}", "encodedeSecret": "${encryptionPack}", "scopes": [] }`);
+  console.log('');
+  console.log('For all scopes that the server should have access to, add them to the "scopes" array.');
+})();

package/genSalt.ts

@@ -0,0 +1,15 @@
+// All chars for randomizer
+const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+
+// Generate a random salt
+let salt = '';
+for (let i = 0; i < 32; i++) {
+  salt += chars.charAt(Math.floor(Math.random() * chars.length));
+}
+salt = Buffer.from(salt).toString('base64');
+
+// Generates 32 byte salt
+console.log('New *receiving* server salt:')
+
+Buffer.from("Hello World").toString('base64')
+console.log(salt);

package/lib/constants/LOG_REVIEW_PAGE_SIZE.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Log reviewer page size
+ * @author Yuen Ler Chow
+ */
+declare const LOG_REVIEW_PAGE_SIZE = 100;
+export default LOG_REVIEW_PAGE_SIZE;

package/lib/constants/LOG_REVIEW_PAGE_SIZE.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Log reviewer page size
+ * @author Yuen Ler Chow
+ */
+var LOG_REVIEW_PAGE_SIZE = 100;
+exports.default = LOG_REVIEW_PAGE_SIZE;
+//# sourceMappingURL=LOG_REVIEW_PAGE_SIZE.js.map

package/lib/constants/LOG_REVIEW_PAGE_SIZE.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LOG_REVIEW_PAGE_SIZE.js","sourceRoot":"","sources":["../../src/constants/LOG_REVIEW_PAGE_SIZE.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAM,oBAAoB,GAAG,GAAG,CAAC;AAEjC,kBAAe,oBAAoB,CAAC"}

package/lib/constants/LOG_REVIEW_ROUTE_PATH_PREFIX.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+declare const LOG_REVIEW_ROUTE_PATH_PREFIX = "/admin/dce-expresskit/logs";
+export default LOG_REVIEW_ROUTE_PATH_PREFIX;

package/lib/constants/LOG_REVIEW_ROUTE_PATH_PREFIX.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var ROUTE_PATH_PREFIX_1 = __importDefault(require("./ROUTE_PATH_PREFIX"));
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+var LOG_REVIEW_ROUTE_PATH_PREFIX = "/admin".concat(ROUTE_PATH_PREFIX_1.default, "/logs");
+exports.default = LOG_REVIEW_ROUTE_PATH_PREFIX;
+//# sourceMappingURL=LOG_REVIEW_ROUTE_PATH_PREFIX.js.map

package/lib/constants/LOG_REVIEW_ROUTE_PATH_PREFIX.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LOG_REVIEW_ROUTE_PATH_PREFIX.js","sourceRoot":"","sources":["../../src/constants/LOG_REVIEW_ROUTE_PATH_PREFIX.ts"],"names":[],"mappings":";;;;;AAAA,0EAAoD;AAEpD;;;GAGG;AACH,IAAM,4BAA4B,GAAG,gBAAS,2BAAiB,UAAO,CAAC;AAEvE,kBAAe,4BAA4B,CAAC"}

package/lib/constants/LOG_REVIEW_STATUS_ROUTE.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Route for checking the status of the current user's
+ *   access to log review
+ * @author Gabe Abrams
+ */
+declare const LOG_REVIEW_STATUS_ROUTE = "/dce-expresskit/logs/access_allowed";
+export default LOG_REVIEW_STATUS_ROUTE;

package/lib/constants/LOG_REVIEW_STATUS_ROUTE.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var ROUTE_PATH_PREFIX_1 = __importDefault(require("./ROUTE_PATH_PREFIX"));
+/**
+ * Route for checking the status of the current user's
+ *   access to log review
+ * @author Gabe Abrams
+ */
+var LOG_REVIEW_STATUS_ROUTE = "".concat(ROUTE_PATH_PREFIX_1.default, "/logs/access_allowed");
+exports.default = LOG_REVIEW_STATUS_ROUTE;
+//# sourceMappingURL=LOG_REVIEW_STATUS_ROUTE.js.map

package/lib/constants/LOG_REVIEW_STATUS_ROUTE.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LOG_REVIEW_STATUS_ROUTE.js","sourceRoot":"","sources":["../../src/constants/LOG_REVIEW_STATUS_ROUTE.ts"],"names":[],"mappings":";;;;;AAAA,0EAAoD;AAEpD;;;;GAIG;AACH,IAAM,uBAAuB,GAAG,UAAG,2BAAiB,yBAAsB,CAAC;AAE3E,kBAAe,uBAAuB,CAAC"}

package/lib/constants/LOG_ROUTE_PATH.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+declare const LOG_ROUTE_PATH = "/dce-expresskit/log";
+export default LOG_ROUTE_PATH;

package/lib/constants/LOG_ROUTE_PATH.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var ROUTE_PATH_PREFIX_1 = __importDefault(require("./ROUTE_PATH_PREFIX"));
+/**
+ * Path of the route for storing client-side logs
+ * @author Gabe Abrams
+ */
+var LOG_ROUTE_PATH = "".concat(ROUTE_PATH_PREFIX_1.default, "/log");
+exports.default = LOG_ROUTE_PATH;
+//# sourceMappingURL=LOG_ROUTE_PATH.js.map

package/lib/constants/LOG_ROUTE_PATH.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LOG_ROUTE_PATH.js","sourceRoot":"","sources":["../../src/constants/LOG_ROUTE_PATH.ts"],"names":[],"mappings":";;;;;AAAA,0EAAoD;AAEpD;;;GAGG;AACH,IAAM,cAAc,GAAG,UAAG,2BAAiB,SAAM,CAAC;AAElD,kBAAe,cAAc,CAAC"}

package/lib/constants/ROUTE_PATH_PREFIX.d.ts

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

package/lib/constants/ROUTE_PATH_PREFIX.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Path that all routes start with
+ * @author Gabe Abrams
+ */
+var ROUTE_PATH_PREFIX = '/dce-expresskit';
+exports.default = ROUTE_PATH_PREFIX;
+//# sourceMappingURL=ROUTE_PATH_PREFIX.js.map

package/lib/constants/ROUTE_PATH_PREFIX.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ROUTE_PATH_PREFIX.js","sourceRoot":"","sources":["../../src/constants/ROUTE_PATH_PREFIX.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,IAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAE5C,kBAAe,iBAAiB,CAAC"}

package/lib/errors/ErrorWithCode.d.ts

@@ -0,0 +1,9 @@
+/**
+ * An error with a code
+ * @author Gabe Abrams
+ */
+declare class ErrorWithCode extends Error {
+    code: string;
+    constructor(message: string, code: string);
+}
+export default ErrorWithCode;

package/lib/errors/ErrorWithCode.js

@@ -0,0 +1,33 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * An error with a code
+ * @author Gabe Abrams
+ */
+var ErrorWithCode = /** @class */ (function (_super) {
+    __extends(ErrorWithCode, _super);
+    function ErrorWithCode(message, code) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'ErrorWithCode';
+        _this.code = code;
+        return _this;
+    }
+    return ErrorWithCode;
+}(Error));
+exports.default = ErrorWithCode;
+//# sourceMappingURL=ErrorWithCode.js.map

package/lib/errors/ErrorWithCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorWithCode.js","sourceRoot":"","sources":["../../src/errors/ErrorWithCode.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;;;GAGG;AACH;IAA4B,iCAAK;IAG/B,uBAAY,OAAe,EAAE,IAAY;QACvC,YAAA,MAAK,YAAC,OAAO,CAAC,SAAC;QACf,KAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,KAAI,CAAC,IAAI,GAAG,IAAI,CAAC;;IACnB,CAAC;IACH,oBAAC;AAAD,CAAC,AARD,CAA4B,KAAK,GAQhC;AAED,kBAAe,aAAa,CAAC"}

package/lib/helpers/addDBEditorEndpoints/generateEndpointPath.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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
+ */
+declare const generateEndpointPath: (collectionName: string, adminsOnly?: boolean) => string;
+export default generateEndpointPath;

package/lib/helpers/addDBEditorEndpoints/generateEndpointPath.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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
+ */
+var generateEndpointPath = function (collectionName, adminsOnly) {
+    // Determine prefix based on whether the endpoint is for admins only
+    var userPath = adminsOnly ? 'admin' : 'ttm';
+    // Return the endpoint path
+    return "/api/".concat(userPath, "/dce-reactkit/dbeditor/").concat(collectionName);
+};
+exports.default = generateEndpointPath;
+//# sourceMappingURL=generateEndpointPath.js.map

package/lib/helpers/addDBEditorEndpoints/generateEndpointPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateEndpointPath.js","sourceRoot":"","sources":["../../../src/helpers/addDBEditorEndpoints/generateEndpointPath.ts"],"names":[],"mappings":";;AAAA;;;;;;GAMG;AACH,IAAM,oBAAoB,GAAG,UAAC,cAAsB,EAAE,UAAoB;IACxE,oEAAoE;IACpE,IAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;IAE9C,2BAA2B;IAC3B,OAAO,eAAQ,QAAQ,oCAA0B,cAAc,CAAE,CAAC;AACpE,CAAC,CAAC;AAEF,kBAAe,oBAAoB,CAAC"}

package/lib/helpers/addDBEditorEndpoints/index.d.ts

@@ -0,0 +1,41 @@
+import express from 'express';
+/**
+ * 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
+ */
+declare const addDBEditorEndpoints: (opts: {
+    app: express.Application;
+    collectionName: string;
+    adminsOnly: boolean;
+    collection: DCEMangoCollection;
+}) => void;
+export default addDBEditorEndpoints;

package/lib/helpers/addDBEditorEndpoints/index.js

@@ -0,0 +1,134 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import dce-reactkit
+var dce_reactkit_1 = require("dce-reactkit");
+// Import shared helpers
+var genRouteHandler_1 = __importDefault(require("../genRouteHandler"));
+var generateEndpointPath_1 = __importDefault(require("./generateEndpointPath"));
+/**
+ * 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
+ */
+var addDBEditorEndpoints = function (opts) {
+    var app = opts.app, collectionName = opts.collectionName, adminsOnly = opts.adminsOnly, collection = opts.collection;
+    // Generate the endpoint path
+    var endpointPath = (0, generateEndpointPath_1.default)(collectionName, adminsOnly);
+    /**
+     * List all items in the collection
+     * @author Yuen Ler Chow
+     * @returns {any[]} the list of items in the collection
+     */
+    app.get(endpointPath, (0, genRouteHandler_1.default)({
+        paramTypes: {
+            filterQuery: dce_reactkit_1.ParamType.JSONOptional,
+        },
+        handler: function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+            var filterQuery, categories;
+            var _c;
+            var params = _b.params;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        filterQuery = (_c = params.filterQuery) !== null && _c !== void 0 ? _c : {};
+                        return [4 /*yield*/, collection.find(filterQuery)];
+                    case 1:
+                        categories = _d.sent();
+                        return [2 /*return*/, categories];
+                }
+            });
+        }); },
+    }));
+    /**
+     * Create a new item in the collection
+     * @author Yuen Ler Chow
+     * @param {any} item the item to create
+     */
+    app.post(endpointPath, (0, genRouteHandler_1.default)({
+        paramTypes: {
+            item: dce_reactkit_1.ParamType.JSON,
+        },
+        handler: function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+            var item;
+            var params = _b.params;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        item = params.item;
+                        return [4 /*yield*/, collection.insert(item)];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); },
+    }));
+    /**
+     * Remove an item from the collection by id
+     * @author Yuen Ler Chow
+     */
+    app.delete("".concat(endpointPath, "/:id"), (0, genRouteHandler_1.default)({
+        paramTypes: {
+            id: dce_reactkit_1.ParamType.String,
+        },
+        handler: function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+            var id;
+            var params = _b.params;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        id = params.id;
+                        return [4 /*yield*/, collection.delete({ id: id })];
+                    case 1:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); },
+    }));
+};
+exports.default = addDBEditorEndpoints;
+//# sourceMappingURL=index.js.map

package/lib/helpers/addDBEditorEndpoints/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/addDBEditorEndpoints/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,sBAAsB;AACtB,6CAEsB;AAEtB,wBAAwB;AACxB,uEAAiD;AACjD,gFAA0D;AAyB1D;;;;;;;;GAQG;AACH,IAAM,oBAAoB,GAAG,UAC3B,IAKC;IAGC,IAAA,GAAG,GAID,IAAI,IAJH,EACH,cAAc,GAGZ,IAAI,eAHQ,EACd,UAAU,GAER,IAAI,WAFI,EACV,UAAU,GACR,IAAI,WADI,CACH;IAET,6BAA6B;IAC7B,IAAM,YAAY,GAAG,IAAA,8BAAoB,EAAC,cAAc,EAAE,UAAU,CAAC,CAAC;IAEtE;;;;OAIG;IACH,GAAG,CAAC,GAAG,CACL,YAAY,EACZ,IAAA,yBAAe,EAAC;QACd,UAAU,EAAE;YACV,WAAW,EAAE,wBAAS,CAAC,YAAY;SACpC;QACD,OAAO,EAAE,iEAAO,EAAU;;;gBAAR,MAAM,YAAA;;;;wBAChB,WAAW,GAAG,MAAA,MAAM,CAAC,WAAW,mCAAI,EAAE,CAAC;wBAC1B,qBAAM,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAA;;wBAA/C,UAAU,GAAG,SAAkC;wBACrD,sBAAO,UAAU,EAAC;;;aACnB;KACF,CAAC,CACH,CAAC;IAEF;;;;OAIG;IACH,GAAG,CAAC,IAAI,CACN,YAAY,EACZ,IAAA,yBAAe,EAAC;QACd,UAAU,EAAE;YACV,IAAI,EAAE,wBAAS,CAAC,IAAI;SACrB;QACD,OAAO,EAAE,iEAAO,EAEf;;gBADC,MAAM,YAAA;;;;wBAIJ,IAAI,GACF,MAAM,KADJ,CACK;wBAEX,qBAAM,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,EAAA;;wBAA7B,SAA6B,CAAC;;;;aAC/B;KACF,CAAC,CACH,CAAC;IAEF;;;OAGG;IACH,GAAG,CAAC,MAAM,CACR,UAAG,YAAY,SAAM,EACrB,IAAA,yBAAe,EAAC;QACd,UAAU,EAAE;YACV,EAAE,EAAE,wBAAS,CAAC,MAAM;SACrB;QACD,OAAO,EAAE,iEAAO,EAEf;;gBADC,MAAM,YAAA;;;;wBAIJ,EAAE,GACA,MAAM,GADN,CACO;wBAEX,qBAAM,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,IAAA,EAAE,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;;;;aACjC;KACF,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,oBAAoB,CAAC"}