updates

utils/functions/sanitizeSql.js

@@ -0,0 +1,201 @@
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Sanitize SQL function
+ * ==============================================================================
+ * @description this function takes in a text(or number) and returns a sanitized
+ * text, usually without spaces
+ *
+ * @param {string|number|object} text - Text or number or object
+ * @param {boolean?} spaces - Allow spaces
+ * @param {RegExp?} regex - Regular expression, removes any match
+ *
+ * @returns {string|object}
+ */
+function sanitizeSql(text, spaces, regex) {
+    /**
+     * Initial Checks
+     *
+     * @description Initial Checks
+     */
+    if (!text) return "";
+    if (typeof text == "number" || typeof text == "boolean") return text;
+    if (typeof text == "string" && !text?.toString()?.match(/./)) return "";
+
+    if (typeof text == "object" && !Array.isArray(text)) {
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+
+        const newObject = sanitizeObjects(text, spaces);
+        return newObject;
+
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+    } else if (typeof text == "object" && Array.isArray(text)) {
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+
+        const newArray = sanitizeArrays(text, spaces);
+        return newArray;
+
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+        ////////////////////////////////////////
+    }
+
+    // if (text?.toString()?.match(/\'|\"/)) {
+    //     console.log("TEXT containing commas =>", text);
+    //     return "";
+    // }
+
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+
+    /**
+     * Declare variables
+     *
+     * @description Declare "results" variable
+     */
+    let finalText = text;
+
+    if (regex) {
+        finalText = text.toString().replace(regex, "");
+    }
+
+    if (spaces) {
+    } else {
+        finalText = text
+            .toString()
+            .replace(/\n|\r|\n\r|\r\n/g, "")
+            .replace(/ /g, "");
+    }
+
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+
+    const escapeRegex = /select |insert |drop |delete |alter |create |exec | union | or | like | concat|LOAD_FILE|ASCII| COLLATE | HAVING | information_schema|DECLARE |\#|WAITFOR |delay |BENCHMARK |\/\*.*\*\//gi;
+
+    finalText = finalText
+        .replace(/(?<!\\)\'/g, "\\'")
+        .replace(/(?<!\\)\`/g, "\\`")
+        // .replace(/(?<!\\)\"/g, '\\"')
+        .replace(/\/\*\*\//g, "")
+        .replace(escapeRegex, "\\$&");
+
+    // const injectionRegexp = /select .* from|\*|delete from|drop database|drop table|update .* set/i;
+
+    // if (text?.toString()?.match(injectionRegexp)) {
+    //     console.log("ATTEMPTED INJECTION =>", text);
+    //     return "";
+    // }
+
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+
+    return finalText;
+
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+    ////////////////////////////////////////
+}
+
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Sanitize Objects Function
+ * ==============================================================================
+ * @description Sanitize objects in the form { key: "value" }
+ *
+ * @param {object} object - Database Full Name
+ * @param {boolean?} spaces - Allow spaces
+ *
+ * @returns {object}
+ */
+function sanitizeObjects(object, spaces) {
+    let objectUpdated = { ...object };
+    const keys = Object.keys(objectUpdated);
+
+    keys.forEach((key) => {
+        const value = objectUpdated[key];
+
+        if (!value) {
+            delete objectUpdated[key];
+            return;
+        }
+
+        if (typeof value == "string" || typeof value == "number") {
+            objectUpdated[key] = sanitizeSql(value, spaces);
+        } else if (typeof value == "object" && !Array.isArray(value)) {
+            objectUpdated[key] = sanitizeObjects(value, spaces);
+        } else if (typeof value == "object" && Array.isArray(value)) {
+            objectUpdated[key] = sanitizeArrays(value, spaces);
+        }
+    });
+
+    return objectUpdated;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Sanitize Objects Function
+ * ==============================================================================
+ * @description Sanitize objects in the form { key: "value" }
+ *
+ * @param {string[]|number[]|object[]} array - Database Full Name
+ * @param {boolean?} spaces - Allow spaces
+ *
+ * @returns {string[]|number[]|object[]}
+ */
+function sanitizeArrays(array, spaces) {
+    let arrayUpdated = [...array];
+
+    arrayUpdated.forEach((item, index) => {
+        const value = item;
+
+        if (!value) {
+            arrayUpdated.splice(index, 1);
+            return;
+        }
+
+        if (typeof item == "string" || typeof item == "number") {
+            arrayUpdated[index] = sanitizeSql(value, spaces);
+        } else if (typeof item == "object" && !Array.isArray(value)) {
+            arrayUpdated[index] = sanitizeObjects(value, spaces);
+        } else if (typeof item == "object" && Array.isArray(value)) {
+            arrayUpdated[index] = sanitizeArrays(item, spaces);
+        }
+    });
+
+    return arrayUpdated;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+
+module.exports = sanitizeSql;

utils/get.js

@@ -15,7 +15,7 @@ const https = require("https");
 /**
  * @typedef {Object} GetReturn
  * @property {boolean} success - Did the function run successfully?
- * @property {(Object[]|string)} [payload=[]] - The Y Coordinate
+ * @property {(Object[]|string)} [payload=[]] - GET request results
  */
 
 /**

utils/post.js

@@ -18,6 +18,17 @@ const https = require("https");
  * @property {(Object[]|string)} [payload=[]] - The Y Coordinate
  */
 
+/**
+ * @typedef {object} PostDataPayload
+ * @property {string} action - "insert" | "update" | "delete"
+ * @property {string} table - Table name(slug) eg "blog_posts"
+ * @property {string} identifierColumnName - Table identifier field name => eg. "id" OR "email"
+ * @property {string} identifierValue - Corresponding value of the selected field name => This
+ * checks for duplicate, and the function will not run if this value is found
+ * @property {object} data - Table insert payload object => This must have keys that match
+ * table fields
+ */
+
 /**
  * ==============================================================================
  * Main Function
@@ -27,13 +38,7 @@ const https = require("https");
  * @param {Object} params - Single object passed
  * @param {string} params.key - API Key
  * @param {string} params.database - Database Name
- * @param {({
- *  action: [string="insert"],
- *  table: string,
- *  identifierColumnName: string,
- *  identifierValue: (string|number),
- *  data: object,
- * } | string)} params.query - SQL query String or Request Object
+ * @param {PostDataPayload} params.query - SQL query String or Request Object
  *
  * @returns { Promise<PostReturn> } - Return Object
  */