@amanat-qa/utils-backend 1.1.5 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amanat-qa/utils-backend",
-  "version": "1.1.5",
+  "version": "1.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -15,6 +15,7 @@
     ".": "./src/index.js",
     "./baseAPI": "./src/API/baseAPI.js",
     "./baseDB": "./src/DB/baseDB.js",
+    "./baseModel": "./src/DB/baseModel.js",
     "./JSONLoader": "./src/data/JSONLoader.js",
     "./JSONMapper": "./src/data/JSONMapper.js",
     "./dataUtils": "./src/data/dataUtils.js",
@@ -31,6 +32,7 @@
     "dotenv": "*",
     "js-yaml": "*",
     "mysql2": "*",
-    "allure-mocha": "*"
+    "allure-mocha": "*",
+    "sequelize": "*"
   }
 }

package/src/API/baseAPI.js

@@ -67,6 +67,32 @@ class BaseAPI {
       return error.response;
     }
   }
+
+  async put(endpoint, params) {
+    Logger.log(`[req] ▶ put ${JSON.stringify(params || {})} to ${endpoint}:`);
+    try {
+      const response = await this.#axiosInstance.put(`/${endpoint}`, params);
+      Logger.log(`[res]   status code: ${response.status}`);
+      return response;
+    } catch (error) {
+      Logger.log(`[res]   status code: ${error.response.status}`);
+      Logger.log(`[res]   body: ${JSON.stringify(error.response.data)}`);
+      return error.response;
+    }
+  }
+
+  async delete(endpoint, params) {
+    Logger.log(`[req] ▶ delete ${JSON.stringify(params || {})} to ${endpoint}:`);
+    try {
+      const response = await this.#axiosInstance.delete(`/${endpoint}`, params);
+      Logger.log(`[res]   status code: ${response.status}`);
+      return response;
+    } catch (error) {
+      Logger.log(`[res]   status code: ${error.response.status}`);
+      Logger.log(`[res]   body: ${JSON.stringify(error.response.data)}`);
+      return error.response;
+    }
+  }
 }
 
 module.exports = BaseAPI; // test commentary... don't mind me

package/src/DB/baseDB.js

@@ -1,58 +1,29 @@
-const mysql = require('mysql2/promise');
+const { Sequelize } = require('sequelize');
 const Logger = require('../log/logger');
 
 class BaseDB {
-  #host;
-
-  #user;
-
-  #port;
-
-  #password;
-
-  #database;
-
-  #connection;
-
-  constructor(host, user, password, database, port) {
-    this.#host = host;
-    this.#user = user;
-    this.#password = password;
-    this.#database = database;
-    this.#port = port;
+  constructor(database) {
+    this.sequelize = new Sequelize(
+      database,
+      process.env.DB_USERNAME,
+      process.env.DB_PASSWORD,
+      {
+        host: process.env.DB_HOST,
+        port: process.env.DB_PORT,
+        dialect: 'mysql',
+        logging: (msg) => Logger.log(`[sql] ▶ ${msg}`),
+      },
+    );
   }
 
   async createConnection() {
-    Logger.log(`[inf] ▶ connect to ${this.#database} database`);
-    this.#connection = await mysql.createConnection({
-      host: this.#host,
-      user: this.#user,
-      password: this.#password,
-      database: this.#database,
-      port: this.#port,
-    });
+    Logger.log(`[inf] ▶ connect to ${this.sequelize.getDatabaseName()} database`);
+    await this.sequelize.authenticate();
   }
 
   async closeConnection() {
-    Logger.log(`[inf] ▶ close connection to ${this.#database} database`);
-    await this.#connection.end();
-  }
-
-  async sqlQuery(query, values) {
-    const [rows] = await this.#connection.query(query, values);
-    return rows;
-  }
-
-  async sqlSelect(
-    tableName,
-    target = '*',
-    conditions = '',
-    values = [],
-    options = { hasLogger: true },
-  ) {
-    if (options.hasLogger) Logger.log(`[inf] ▶ select ${target} from ${tableName} table`);
-    const query = `SELECT ${target} FROM ${tableName} ${conditions};`;
-    return this.sqlQuery(query, values);
+    Logger.log(`[inf] ▶ close connection to ${this.sequelize.getDatabaseName()} database`);
+    await this.sequelize.close();
   }
 }
 

package/src/DB/baseModel.js

@@ -0,0 +1,23 @@
+const { DataTypes } = require('sequelize');
+
+module.exports = {
+  attributes: {
+    id: { type: DataTypes.BIGINT.UNSIGNED, primaryKey: true, autoIncrement: true },
+  },
+  getOptions: ({ tableName, withSoftDelete = false } = {}) => {
+    const options = {
+      timestamps: true,
+      underscored: true,
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+      tableName,
+    };
+
+    if (withSoftDelete) {
+      options.paranoid = true;
+      options.deletedAt = 'deleted_at';
+    }
+
+    return options;
+  },
+};

package/src/index.js

@@ -2,6 +2,7 @@
 
 exports.BaseAPI = require('./API/baseAPI');
 exports.BaseDB = require('./DB/baseDB');
+exports.baseModel = require('./DB/baseModel');
 exports.JSONLoader = require('./data/JSONLoader');
 exports.JSONMapper = require('./data/JSONMapper');
 exports.DataUtils = require('./data/dataUtils');