[Delivers #187584922] Admin should be able to disable an account (#25)

* [Delivers #187584922] Admin should be able to disable an account

* Admin should be able to disable or enable an account

* Admin should be able to disable or enable an account

* Admin should be able to disable or enable an account

* Admin should be able to disable or enable an account

* Admin should be able to disable or enable an account

* Adjusted the database

* DB adjusted

* adjusted info

* done rebase

.github/workflows/ci.yml

@@ -61,4 +61,4 @@ jobs:
       - name: Upload coverage to Coveralls
         uses: coverallsapp/github-action@v2
         env:
-          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}

.hintrc

@@ -0,0 +1,8 @@
+{
+  "extends": [
+    "development"
+  ],
+  "hints": {
+    "typescript-config/strict": "off"
+  }
+}

.sequelizerc

@@ -1,7 +1,7 @@
 const path = require("path");
 module.exports = {
-  'config': path.resolve('dist/src','databases', 'config', 'config.js'),
-  'models-path': path.resolve('dist/src','databases', 'models'),
-  'seeders-path': path.resolve('dist/src','databases', 'seeders'),
-  'migrations-path': path.resolve('dist/src','databases', 'migrations')
-};
+  'config': path.resolve('dist/src', 'databases', 'config', 'config.js'),
+  'models-path': path.resolve('dist/src', 'databases', 'models'),
+  'seeders-path': path.resolve('dist/src', 'databases', 'seeders'),
+  'migrations-path': path.resolve('dist/src', 'databases', 'migrations')
+};

README.md

@@ -30,18 +30,19 @@ This is the backend for E-Commerce-Ninjas, written in Node.js with TypeScript.
 - Verification Email Endpoint
 - Resend verification Endpoint
 - Login Endpoint
+- Admin change status Endpoint
 
 ## TABLE OF API ENDPOINTS SPECIFICATION AND DESCRIPTION
 
 
-| No | VERBS | ENDPOINTS                    | STATUS      | ACCESS | DESCRIPTION               |
-|----|-------|------------------------------|-------------|--------|---------------------------|
-| 1  | GET   | /                            | 200 OK      | public | Show welcome message      |
-| 2  | POST  | /api/auth/register           | 201 CREATED | public | create user account       |
-| 3  | GET   | /api/auth/verify-email/:token| 200 OK      | public | Verifying email           |
-| 4  | POST  | /api/auth/send-verify-email  | 200 OK      | public | Resend verification email |
-| 4  | POST  | /api/auth/login              | 200 OK      | public | Login with Email and Password |
-
+| No | VERBS | ENDPOINTS                               | STATUS      | ACCESS  | DESCRIPTION                   |
+|----|-------|-----------------------------------------|-------------|---------|-------------------------------|
+| 1  | GET   | /                                       | 200 OK      | public  | Show welcome message          |
+| 2  | POST  | /api/auth/register                      | 201 CREATED | public  | create user account           |
+| 3  | GET   | /api/auth/verify-email/:token           | 200 OK      | public  | Verifying email               |
+| 4  | POST  | /api/auth/send-verify-email             | 200 OK      | public  | Resend verification email     |
+| 5  | POST  | /api/auth/login                         | 200 OK      | public  | Login with Email and Password |
+| 6  | PUT   | /api/users/admin-update-user-status/:id | 200 OK      | private | Admin change status           |
 
 
 ## INSTALLATION

package.json

@@ -108,4 +108,4 @@
     "eslint-plugin-import": "^2.29.1",
     "lint-staged": "^15.2.2"
   }
-}
+}

src/databases/config/config.ts

@@ -33,4 +33,4 @@ const sequelizeConfig = {
   }
 };
 
-module.exports = sequelizeConfig;
+module.exports = sequelizeConfig;

src/databases/config/db.config.ts

@@ -1,44 +1,44 @@
-import { config } from "dotenv"
-import { Sequelize } from "sequelize"
-
-config()
-const NODE_ENV: string = process.env.NODE_ENV || "development"
-const DB_HOST_MODE: string = process.env.DB_HOST_TYPE || "remote"
-
-/**
- * Get the URI for the database connection.
- * @returns {string} The URI string.
- */
-function getDbUri(): string {
-  switch (NODE_ENV) {
-    case "development":
-      return process.env.DATABASE_URL_DEV as string
-    case "test":
-      return process.env.DATABASE_URL_TEST as string
-    default:
-      return process.env.DATABASE_URL_PRO as string
-  }
-}
-
-/**
- * Get dialect options for Sequelize.
- * @returns {DialectOptions} The dialect options.
- */
-function getDialectOptions() {
-  return DB_HOST_MODE === "local"
-    ? {}
-    : {
-        ssl: {
-          require: true,
-          rejectUnauthorized: false
-        }
-      }
-}
-
-const sequelizeConnection: Sequelize = new Sequelize(getDbUri(), {
-  dialect: "postgres",
-  dialectOptions: getDialectOptions(),
-  logging: false
-})
-
-export default sequelizeConnection
+import { config } from "dotenv"
+import { Sequelize } from "sequelize"
+
+config()
+const NODE_ENV: string = process.env.NODE_ENV || "development"
+const DB_HOST_MODE: string = process.env.DB_HOST_TYPE || "remote"
+
+/**
+ * Get the URI for the database connection.
+ * @returns {string} The URI string.
+ */
+function getDbUri(): string {
+  switch (NODE_ENV) {
+    case "development":
+      return process.env.DATABASE_URL_DEV as string
+    case "test":
+      return process.env.DATABASE_URL_TEST as string
+    default:
+      return process.env.DATABASE_URL_PRO as string
+  }
+}
+
+/**
+ * Get dialect options for Sequelize.
+ * @returns {DialectOptions} The dialect options.
+ */
+function getDialectOptions() {
+  return DB_HOST_MODE === "local"
+    ? {}
+    : {
+        ssl: {
+          require: true,
+          rejectUnauthorized: false
+        }
+      }
+}
+
+const sequelizeConnection: Sequelize = new Sequelize(getDbUri(), {
+  dialect: "postgres",
+  dialectOptions: getDialectOptions(),
+  logging: false
+})
+
+export default sequelizeConnection

src/databases/migrations/20240520180022-create-users.ts

@@ -75,7 +75,7 @@ export default {
       status: {
         type: new DataTypes.STRING(128),
         allowNull: false,
-        defaultValue: true
+        defaultValue: "enabled"
       },
       createdAt: {
         allowNull: false,
@@ -99,4 +99,4 @@ export default {
       DROP TYPE IF EXISTS "enum_users_gender";
     `);
   }
-};
+};

src/databases/models/users.ts

@@ -20,7 +20,7 @@ export interface UsersAttributes {
     role?: string;
     isVerified?: boolean;
     is2FAEnabled?: boolean;
-    status?: boolean;
+    status?: string;
     createdAt?: Date;
     updatedAt?: Date;
 }
@@ -42,7 +42,7 @@ class Users extends Model<UsersAttributes, UsersCreationAttributes> implements U
     declare role?: string;
     declare isVerified?: boolean;
     declare is2FAEnabled?: boolean;
-    declare status?: boolean;
+    declare status?: string;
     declare password: string;
     declare createdAt?: Date;
     declare updatedAt?: Date;
@@ -122,7 +122,7 @@ Users.init(
         status: {
             type: new DataTypes.STRING(128),
             allowNull: true,
-            defaultValue: true
+            defaultValue: "enabled"
         },
         createdAt: {
             field: "createdAt",
@@ -152,4 +152,4 @@ Users.init(
     }
 );
 
-export default Users;
+export default Users;

src/databases/seeders/20240520202759-users.ts

@@ -12,7 +12,8 @@ const userOne = {
   birthDate: "2-2-2014",
   language: "english",
   currency: "USD",
-  role: "buyer"
+  role: "buyer",
+  status: "enabled"
 }
 const userTwo = {
   createdAt: new Date(),
@@ -27,7 +28,8 @@ const userTwo = {
   birthDate: "1990-01-01",
   language: "English",
   currency: "USD",
-  role: "buyer"
+  role: "buyer",
+  status: "enabled"
 }
 
 const userThree = {
@@ -43,7 +45,8 @@ const userThree = {
   birthDate: "2-2-2014",
   language: "english",
   currency: "USD",
-  role: "buyer"
+  role: "buyer",
+  status: "enabled"
 }
 
 const up = (queryInterface: QueryInterface) => queryInterface.bulkInsert("users",[userOne, userTwo, userThree])

src/index.ts

@@ -7,6 +7,7 @@ import SwaggerUi from "swagger-ui-express";
 import Document from "../swagger.json";
 import router from "./routes";
 
+
 dotenv.config();
 const app: Express = express();
 
@@ -16,10 +17,10 @@ app.use(express.json());
 app.use(morgan(process.env.NODE_EN));
 app.use(compression());
 app.use(cors());
-app.use("/api",router);
 app.use("/api-docs", SwaggerUi.serve, SwaggerUi.setup(Document));
+app.use("/api", router);
 
-app.get("/", (req: Request, res: Response) => {
+app.get("**", (req: Request, res: Response) => {
   res
     .status(200)
     .json({ status: true, message: "Welcome to the e-Commerce Ninjas BackEnd." });

src/middlewares/validation.ts

@@ -40,7 +40,7 @@ const isUserExist = async (req: Request, res: Response, next: NextFunction) => {
             if (userExists) {
                 return next();
             }
-            return res.status(httpStatus.BAD_REQUEST).json({ status: httpStatus.BAD_REQUEST, message: "User not found" });
+            return res.status(httpStatus.NOT_FOUND).json({ status: httpStatus.NOT_FOUND, message: "User not found" });
         }
 
         return next();

src/modules/auth/repository/authRepositories.ts

@@ -12,7 +12,8 @@ const findUserByAttributes = async (key:string, value:any) =>{
 }
 
 const UpdateUserByAttributes = async (updatedKey:string, updatedValue:any, whereKey:string, whereValue:any) =>{
-    return await Users.update({ [updatedKey]: updatedValue }, { where: { [whereKey]: whereValue} });
+    await Users.update({ [updatedKey]: updatedValue }, { where: { [whereKey]: whereValue} });
+    return await findUserByAttributes(whereKey, whereValue)
 }
 
 const createSession = async (body: any) => {

src/modules/auth/test/auth.spec.ts

@@ -162,7 +162,6 @@ describe("isUserExist Middleware", () => {
 
   afterEach(async () => {
     sinon.restore();
-    await Users.destroy({ where: {} });
   });
 
   it("should return user already exists", (done) => {

src/modules/user/controller/userControllers.ts

@@ -0,0 +1,14 @@
+import { Request, Response } from "express";
+import httpStatus from "http-status";
+import authRepositories from "../../auth/repository/authRepositories";
+
+const updateUserStatus = async (req: Request, res: Response): Promise<void> => {
+  try {
+    const userId: number = Number(req.params.id);
+    const data = await authRepositories.UpdateUserByAttributes("status", req.body.status, "id", userId);
+    res.status(httpStatus.OK).json({ message: "Status updated successfully.", data });
+  } catch (error) {
+    res.status(httpStatus.INTERNAL_SERVER_ERROR).json({ status: httpStatus.INTERNAL_SERVER_ERROR, message: error.message });
+  }
+};
+export default { updateUserStatus };

src/modules/user/repository/userRepositories.ts

@@ -0,0 +1 @@
+