ags-sql-gen 1.0.2 → 1.0.4

package/README.md

@@ -1,13 +1,15 @@
+
 # AGS SQL Library
 
 AGS is a lightweight Node.js MySQL helper library that simplifies database operations such as **SELECT**, **INSERT**, **UPDATE**, **DELETE**, and **JOIN** queries.  
 It also includes a fun bonus function: `getDadJokes()` — because debugging is better with a laugh. 😄
+`AGS-SQL-Template` is a ready-to-use SQL helper class designed for developers who frequently interact with MySQL databases in Node.js.  
+It provides easy methods for `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `JOIN`, and aggregation queries (`SUM`, `MIN`, `MAX`, `AVG`) without needing to manually write long SQL statements every time.
 
----
 
 ## 🚀 Features
 
-- Simple MySQL query wrapper using async/await  
+- Simple MySQL query wrapper using async/await
 - Automatic handling for:
   - Single or multiple table queries
   - Batch insert, update, and delete
@@ -15,78 +17,111 @@ It also includes a fun bonus function: `getDadJokes()` — because debugging is
 - Minimal setup required — just plug in your MySQL connection
 - Fun extra: fetches a random dad joke via `curl`
 
----
-
 ## 📦 Installation
 
 ```bash
-npm install ags-sql-lib mysql2
+npm install ags-sql-lib 
+npm install mysql2
+```
+## Usage Sample
 
-## Importing
+### Importing
+```js
 import AGS from "ags-sql-lib";
 
-const sql = new AGS("root", "password", "localhost", "my_database");
-
-// Select all columns
-const result = await sql.select("*", "users");
-
-// Select from multiple tables
-const result = await sql.select("*", ["users", "products"]);
-
-// Single
-const user = await sql.selectWithId("id", "*", "users", 1);
-
-// Multiple
-const users = await sql.selectWithId("id", "*", "users", [1, 2, 3]);
-
-## InsertInto
-// Single insert
-await sql.insertInto("users", { name: "John", age: 25 });
-
-// Multiple inserts
-await sql.insertInto("users", [
+const sql = new AGS.connect("root", "password", "localhost", "my_database");
+```
+### select
+Select all columns
+```js
+const result = await sql.select("*", "tblusers");
+
+Select from multiple tables
+const result = await sql.select("*", ["tblusers", "products"]);
+
+Single
+const user = await sql.selectWithId("id", "*", "tblusers", 1);
+
+Multiple
+const users = await sql.selectWithId("id", "*", "tblusers", [1, 2, 3]);
+```
+### InsertInto
+Single insert
+```js
+await sql.insertInto("tblusers", { name: "John", age: 25 });
+```
+Multiple inserts
+```js
+await sql.insertInto("tblusers", [
   { name: "Alice", age: 22 },
   { name: "Bob", age: 30 }
 ]);
-
-// Single update
-await sql.update("id", "users", { age: 26 }, 1);
-
-// Multiple updates
-await sql.update("id", "users", [{ age: 22 }, { age: 28 }], [1, 2]);
-
-## DELETE
-
-// Single delete
-await sql.delete("users", "id", 1);
-
-// Multiple delete
-await sql.delete("users", "id", [2, 3]);
-
-## Joining Table
-
-// LEFT JOIN example
+```
+### Update
+Single update
+```js
+await sql.update("id", "tblusers", { age: 26 }, 1);
+```
+Multiple updates
+```js
+await sql.update("id", "tblusers", [{ age: 22 }, { age: 28 }], [1, 2]);
+```
+### DELETE
+Single delete
+```js
+await sql.delete("tblusers", "id", 1);
+
+Multiple delete
+await sql.delete("tblusers", "id", [2, 3]);
+```
+### Joining Table
+
+LEFT JOIN example
+```js
 const result = await sql.selectLeftAndRightJoin(
-  "users",
-  "orders",
-  "users.name, orders.total",
-  "users.id = orders.user_id",
-  "users.id",
+  "tblusers",
+  "tblorders",
+  "tblusers.name, tblorders.total",
+  "tblusers.id = tblorders.user_id",
+  "tblusers.id",
   "LEFT JOIN",
   1
 );
-
-// INNER JOIN
+```
+INNER JOIN
+```js
 const result = await sql.selectInnerJoin(
-  "users",
-  "orders",
-  "users.name, orders.total",
-  "users.id = orders.user_id"
+  "tblusers",
+  "tblorders",
+  "tblusers.name, tblorders.total",
+  "tblusers.id = tblorders.user_id"
 );
-
-## BONUS
-
+```
+### Aggregation queries
+
+```js
+Calculate the total of all 'grade' values in one table
+const totalGrades = await sql.sum("grade", "tbl_grades");
+
+Get the lowest grade
+const lowestGrade = await sql.min("grade", "tbl_grades");
+
+Get the highest grade
+const highestGrade = await sql.max("grade", "tbl_grades");
+
+Get the average grade
+const averageGrade = await sql.avg("grade", "tbl_grades");
+
+multiple tables
+const totalResults = await db.sum("amount", ["tbl_sales", "tbl_purchases"]);
+const minResults = await db.min("score", ["tbl_quiz1", "tbl_quiz2"]);
+const maxResults = await db.max("salary", ["tbl_teachers", "tbl_admin"]);
+const avgResults = await db.avg("grade", ["tbl_midterm", "tbl_final"]);
+```
+### BONUS
+```js
 import { getDadJokes } from "ags-sql-lib";
 
 const joke = await getDadJokes();
 console.log(joke);
+

package/connection.js

@@ -0,0 +1,217 @@
+import connection from "./database/dbConnection.js";
+
+export default class {
+    #sqlOperation;
+
+    constructor(user, password, host, database) {
+        this.#sqlOperation = connection(user, password, host, database);
+    }
+
+    async select(columnName, tableName) {
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT * FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT ${columnName || "*"} FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async selectWithId(yourIdName, columnName, tableName, idValue) {
+    
+    try {
+      if(Array.isArray(idValue)){
+        let result = [];
+        for(let i in idValue){
+          const sql = `SELECT ${columnName || "*"} FROM ${tableName} WHERE ${
+      yourIdName || "Id"
+    } = ${idValue[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql)
+          result.push(selectResult[0]);
+        }
+        return result;
+      }
+
+      const sql = `SELECT ${columnName || "*"} FROM ${tableName} WHERE ${
+      yourIdName || "Id"
+    } = ${idValue}`;
+      const [selectResult] = await this.#sqlOperation.query(sql)
+      return selectResult[0];
+
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async insertInto(tableName, objectValue) {
+    try {
+     if(Array.isArray(objectValue)){
+      let result = [];
+      for(let i in objectValue){
+        const sql = `INSERT INTO ${tableName} SET ?`;
+        const [insertResult] = await this.#sqlOperation.query(sql, [objectValue[i]]);
+        result.push(insertResult);
+      }
+      return result;
+     }
+    const sql = `INSERT INTO ${tableName} SET ?`;
+    const [insertResult] = await this.#sqlOperation.query(sql, [objectValue]);
+    return insertResult;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async update(yourIdName, tableName, objectValue, idValue) {
+   
+    try {
+      if(Array.isArray(objectValue) && Array.isArray(idValue)){
+        let result = [];
+        for(let i in objectValue){
+          const sql = `UPDATE ${tableName} SET ? WHERE ${yourIdName} = ${idValue[i]}`;
+          const [updateResult] = await this.#sqlOperation.query(sql, [objectValue[i]]);
+          result.push(updateResult);
+        }
+        return result;
+      }
+      const sql = `UPDATE ${tableName} SET ? WHERE ${yourIdName} = ${idValue}`;
+      const [updateResult] = await this.#sqlOperation.query(sql, [objectValue]);
+      return updateResult;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async delete(tableName, yourIdName, idValue) {
+    try {
+      if(Array.isArray(idValue)){
+        let result = [];
+        for(let i in idValue){
+          const sql = `DELETE FROM ${tableName} WHERE ${yourIdName || "Id"} = ${idValue[i]}`;
+          const [deleteResult] = await this.#sqlOperation.query(sql);
+          result.push(deleteResult);
+        }
+        return result;
+      }
+      const sql = `DELETE FROM ${tableName} WHERE ${yourIdName || "Id"} = ${idValue}`;
+      const [deleteResult] = await this.#sqlOperation.query(sql);
+      return deleteResult;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async selectLeftAndRightJoin(tbl_a, tbl_b, columnName, onCondition, yourIdName, joinType, idValue) {
+    try {
+      if(Array.isArray(idValue)){
+        let result = [];
+        for(let i in idValue){
+          const sql = `SELECT ${columnName || "*"} FROM ${tbl_a} ${joinType} ${tbl_b} ON ${onCondition} WHERE ${yourIdName} = ${idValue[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult[0]);
+        }
+        return result;
+      }
+      const sql = `SELECT ${columnName || "*"} FROM ${tbl_a} ${joinType} ${tbl_b} ON ${onCondition} WHERE ${yourIdName} = ${idValue}`;
+      const [selectResult] = await this.#sqlOperation.query(sql);
+      return selectResult;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async selectInnerJoin(tbl_a, tbl_b, columnName, onCondition){
+   try {
+    const sql = `SELECT ${columnName || "*"} FROM ${tbl_a} INNER JOIN ${tbl_b} ON ${onCondition}`;
+    const [result] = await this.#sqlOperation.query(sql);
+    return result;
+   } catch (error) {
+    console.log(error);
+   }
+  }
+
+  async sum(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT SUM(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT SUM(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async max(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT MAX(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT MAX(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async min(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT MIN(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT MIN(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async avg(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT AVG(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT AVG(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+};

package/database/dbConnection.js

@@ -1,6 +1,6 @@
 import mysql from "mysql2";
 
-export const db = (user, password, host, database) => {
+export default (user, password, host, database) => {
   const dbConnection = mysql
     .createPool({
       user: user,
@@ -11,4 +11,4 @@ export const db = (user, password, host, database) => {
     .promise();
 
   return dbConnection;
-};
+}

package/getJokes.js

@@ -0,0 +1,13 @@
+import { exec } from "child_process";
+
+export default async () => {
+  return new Promise((resolve, reject) => {
+    try {
+      exec("curl https://icanhazdadjoke.com", (error, stdout, stderr) => {
+        return resolve(stdout);
+      });
+    } catch (error) {
+      return reject(error);
+    }
+  });
+};

package/index.js

@@ -1,158 +1,7 @@
-import { exec } from "child_process";
-import { db } from "./database/dbConnection.js";
+import connect from "./connection.js";
+import getJokes from "./getJokes.js";
 
-class AGS {
-
-  #sqlOperation;
-
-  constructor(aUser, aPassword, aHost, aDatabase) {
-    this.#sqlOperation = db(aUser, aPassword, aHost, aDatabase);
-  }
-
-  async select(columnName, tableName) {
-    try {
-      if(Array.isArray(tableName)){
-        let result = [];
-        for(let i in tableName){
-          const sql = `SELECT * FROM ${tableName[i]}`;
-          const [selectResult] = await this.#sqlOperation.query(sql);
-          result.push(selectResult);
-        }
-        return result;
-      }
-
-      const sql = `SELECT ${columnName || "*"} FROM ${tableName}`;
-      const [result] = await this.#sqlOperation.query(sql);
-      return result;
-    } catch (error) {
-      console.log(error);
-    }
-  }
-
-  async selectWithId(yourIdName, columnName, tableName, idValue) {
-    
-    try {
-      if(Array.isArray(idValue)){
-        let result = [];
-        for(let i in idValue){
-          const sql = `SELECT ${columnName || "*"} FROM ${tableName} WHERE ${
-      yourIdName || "Id"
-    } = ${idValue[i]}`;
-          const [selectResult] = await this.#sqlOperation.query(sql)
-          result.push(selectResult[0]);
-        }
-        return result;
-      }
-
-      const sql = `SELECT ${columnName || "*"} FROM ${tableName} WHERE ${
-      yourIdName || "Id"
-    } = ${idValue}`;
-      const [selectResult] = await this.#sqlOperation.query(sql)
-      return selectResult[0];
-
-    } catch (error) {
-      console.log(error);
-    }
-  }
-
-  async insertInto(tableName, objectValue) {
-    try {
-     if(Array.isArray(objectValue)){
-      let result = [];
-      for(let i in objectValue){
-        const sql = `INSERT INTO ${tableName} SET ?`;
-        const [insertResult] = await this.#sqlOperation.query(sql, [objectValue[i]]);
-        result.push(insertResult);
-      }
-      return result;
-     }
-    const sql = `INSERT INTO ${tableName} SET ?`;
-    const [insertResult] = await this.#sqlOperation.query(sql, [objectValue]);
-    return insertResult;
-    } catch (error) {
-      console.log(error);
-    }
-  }
-
-  async update(yourIdName, tableName, objectValue, idValue) {
-   
-    try {
-      if(Array.isArray(objectValue) && Array.isArray(idValue)){
-        let result = [];
-        for(let i in objectValue){
-          const sql = `UPDATE ${tableName} SET ? WHERE ${yourIdName} = ${idValue[i]}`;
-          const [updateResult] = await this.#sqlOperation.query(sql, [objectValue[i]]);
-          result.push(updateResult);
-        }
-        return result;
-      }
-      const sql = `UPDATE ${tableName} SET ? WHERE ${yourIdName} = ${idValue}`;
-      const [updateResult] = await this.#sqlOperation.query(sql, [objectValue]);
-      return updateResult;
-    } catch (error) {
-      console.log(error);
-    }
-  }
-
-  async delete(tableName, yourIdName, idValue) {
-    try {
-      if(Array.isArray(idValue)){
-        let result = [];
-        for(let i in idValue){
-          const sql = `DELETE FROM ${tableName} WHERE ${yourIdName || "Id"} = ${idValue[i]}`;
-          const [deleteResult] = await this.#sqlOperation.query(sql);
-          result.push(deleteResult);
-        }
-        return result;
-      }
-      const sql = `DELETE FROM ${tableName} WHERE ${yourIdName || "Id"} = ${idValue}`;
-      const [deleteResult] = await this.#sqlOperation.query(sql);
-      return deleteResult;
-    } catch (error) {
-      console.log(error);
-    }
-  }
-
-  async selectLeftAndRightJoin(tbl_a, tbl_b, columnName, onCondition, yourIdName, joinType, idValue) {
-    try {
-      if(Array.isArray(idValue)){
-        let result = [];
-        for(let i in idValue){
-          const sql = `SELECT ${columnName || "*"} FROM ${tbl_a} ${joinType} ${tbl_b} ON ${onCondition} WHERE ${yourIdName} = ${idValue[i]}`;
-          const [selectResult] = await this.#sqlOperation.query(sql);
-          result.push(selectResult[0]);
-        }
-        return result;
-      }
-      const sql = `SELECT ${columnName || "*"} FROM ${tbl_a} ${joinType} ${tbl_b} ON ${onCondition} WHERE ${yourIdName} = ${idValue}`;
-      const [selectResult] = await this.#sqlOperation.query(sql);
-      return selectResult;
-    } catch (error) {
-      console.log(error);
-    }
-  }
-
-  async selectInnerJoin(tbl_a, tbl_b, columnName, onCondition){
-   try {
-    const sql = `SELECT ${columnName || "*"} FROM ${tbl_a} INNER JOIN ${tbl_b} ON ${onCondition}`;
-    const [result] = await this.#sqlOperation.query(sql);
-    return result;
-   } catch (error) {
-    console.log(error);
-   }
-  }
-}
-
-export const getDadJokes = async () => {
-  return new Promise((resolve, reject) => {
-    try {
-      exec("curl https://icanhazdadjoke.com", (error, stdout, stderr) => {
-        return resolve(stdout);
-      });
-    } catch (error) {
-      return reject(error);
-    }
-  });
+export default {
+  connect,
+  getJokes
 };
-
-export default AGS;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "ags-sql-gen",
-  "version": "1.0.2",
-  "description": "preset query",
+  "version": "1.0.4",
+  "description": "lightweight Node.js MySQL helper library",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Adrian294-AGS/AGS-SQL-Template.git"