Content Manager: Added Documentation, Implemented functional approach to the HTML table generation and refactored API codes, Using DOM purifier to prevent XSS

src-manager/utils/asyncDatabase.js

@@ -1,10 +1,17 @@
+/**
+ * @module utils/asyncDatabase
+ */
 import sqlite3 from 'sqlite3';
 
 /**
- * @param database
- * @param sqlQuery
- * @param callback - (rows) => {}
- * @returns - Promise for database operation
+ * @param {sqlite3.Database} database
+ * @param {string} sqlQuery
+ * @param {function} callback - function (rows)
+ * @returns {Promise<any>} Promise for database operation
+ * @example
+ * const result = await asyncDatabaseRead(userDatabase, `SELECT * FROM users`, (rows) => {
+ *     return wrapInTable(rows);
+ * });
  */
 const asyncDatabaseRead = (database, sqlQuery, callback) => {
     return new Promise((resolve, reject) => {
@@ -21,10 +28,15 @@ const asyncDatabaseRead = (database, sqlQuery, callback) => {
 };
 
 /**
- * @param database
- * @param sqlQuery
- * @param callback - () => {}
- * @returns - Promise for database operation
+ * @param {sqlite3.Database} database
+ * @param {string} sqlQuery
+ * @param {function} callback - function ()
+ * @returns {Promise<any>} Promise for database operation
+ * @example
+ * let sqlQuery = `INSERT INTO users (id, name, age) VALUES (${genID()}, "${userName}", "${userAge}");`;
+ * await asyncDatabaseWrite(userDatabase, sqlQuery, () => {
+ *     console.log("Added User ", userName);
+ * });
  */
 const asyncDatabaseWrite = (database, sqlQuery, callback) => {
     return new Promise((resolve, reject) => {
@@ -40,4 +52,4 @@ const asyncDatabaseWrite = (database, sqlQuery, callback) => {
     });
 };
 
-export { asyncDatabaseRead, asyncDatabaseWrite };
+export { asyncDatabaseRead, asyncDatabaseWrite };

src-manager/utils/tableWrapper.js

@@ -0,0 +1,39 @@
+/**
+ * @module utils/tableWrapper
+ */
+
+/**
+ * Wrap object array into HTML table body tr+td's
+ * @param {Object[]} target - array of objects
+ * @returns {string} Stringed HTML table body tr+td's
+ * @example
+ * const data = [
+ *     {id: 1, name: "John"},
+ *     {id: 2, name: "Marry"},
+ * ];
+ * const responseHTML = wrapInTable(data);
+ * // responseHTML =
+ * // <tr>
+ * //     <td>1</td>
+ * //     <td>John</td>
+ * // </tr>
+ * // <tr>
+ * //     <td>2</td>
+ * //     <td>Marry</td>
+ * // </tr>
+ */
+const wrapInTable = (target) => {
+    let res = "";
+    for (const entry of target) {
+        let tableData = "<tr>\n";
+        for (const data in entry) {
+            let dataEntry = `    <td>${entry[data]}</td>\n`
+            tableData = tableData + dataEntry;
+        }
+        tableData = tableData + "</tr>\n";
+        res = res + tableData;
+    }
+    return res;
+};
+
+export { wrapInTable };