Feature Admin update role 187584923

.env.example

@@ -1,10 +1,28 @@
 PORT=
-NODE_ENV=
 NODE_EN=
-DOCKER_DATABASE_HOST_AUTH_METHOD=
-DOCKER_DATABASE_NAME=
-DOCKER_DATABASE_PASSWORD=
+JWT_SECRET=
+NODE_ENV=
+
+SMTP_HOST_PORT=
+MP=
+SMTP_HOST=
+MAIL_ID=
+
+CLOUD_NAME= 
+API_KEY= 
+API_SECRET=
+
+SERVER_URL_DEV=
+SERVER_URL_PRO=
+
 DATABASE_URL_DEV=
 DATABASE_URL_TEST=
 DATABASE_URL_PRO=
-DB_HOST_TYPE=
+
+
+
+DB_HOST_TYPE=
+DOCKER_DATABASE_USER=
+DOCKER_DATABASE_HOST_AUTH_METHOD=
+DOCKER_DATABASE_NAME=
+DOCKER_DATABASE_PASSWORD=

.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

@@ -1,4 +1,4 @@
-# Team Ninjas Backend
+# TEAM NINJAS BACKEND
 
 This is the backend for E-Commerce-Ninjas, written in Node.js with TypeScript.
 
@@ -23,26 +23,31 @@ This is the backend for E-Commerce-Ninjas, written in Node.js with TypeScript.
 [https://github.com/atlp-rwanda/e-commerce-ninjas-bn](https://github.com/atlp-rwanda/e-commerce-ninjas-bn)
 
 
-## Completed Features
+## COMPLETED FEATURES
 
 - Welcome Endpoint
 - Register Endpoint
 - Verification Email Endpoint
 - Resend verification Endpoint
+- Login Endpoint
+- Admin Update Status Endpoint
+- Admin Update Role Endpoint
 
 ## TABLE OF API ENDPOINTS SPECIFICATION AND DESCRIPTION
 
 
-| No | VERBS | ENDPOINTS                    | STATUS      | ACCESS | DESCRIPTION               |
-|----|-------|------------------------------|-------------|--------|---------------------------|
-| 1  | GET   | /                            | 200 OK      | public | Show welcome message      |
-| 2  | GET   | /api/auth/verify-email/:token| 200 OK      | public | Verifying email           |
-| 3  | POST  | /api/auth/register           | 201 CREATED | public | create user account       |
-| 4  | POST  | /api/auth/send-verify-email  | 200 OK      | public | Resend verification email |
+| 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 |
+| 5 | PUT    | /api/users/admin-update-role/:id        | 200 OK      | private | Update the user role by admin|
+| 6  | PUT   | /api/users/admin-update-user-status/:id | 200 OK      | private | Admin Update Status Endpoint          |
+| 7  | PUT   | /api/users/admin-update-role/:id        | 200 OK      | private |  Admin Update Role Endpoint  |
 
-
-
-## Installation
+## INSTALLATION
 
 1. Clone the repository:
 
@@ -63,7 +68,7 @@ This is the backend for E-Commerce-Ninjas, written in Node.js with TypeScript.
    npm run dev
    ```
 
-## Folder Structure
+## FOLDER STRUCTURE
 
 - `.env`: Secure environment variables.
 - `src/`: Source code directory.
@@ -84,7 +89,7 @@ This is the backend for E-Commerce-Ninjas, written in Node.js with TypeScript.
   - `services/`: Service functions like sendEmails.
   - `index.ts`: Startup file for all requests.
 
-## Initialize Sequelize CLI
+## INITILIAZE SEQUELIZE CLI
 
 1. Initialize Sequelize CLI:
     ```sh
@@ -117,43 +122,4 @@ This is the backend for E-Commerce-Ninjas, written in Node.js with TypeScript.
 9. Delete the Migration:
     ```sh
     npm run deleteAllTables
-    ```
-
-
-
-## Initialize Sequelize CLI
-
-1. Initialize Sequelize CLI:
-    ```sh
-    npx sequelize-cli init
-    ```
-2. Generate Seeder:
-    ```sh
-    npx sequelize-cli seed:generate --name name-of-your-seeder
-    ```
-3. Generate Migrations:
-    ```sh
-    npx sequelize-cli migration:generate --name name-of-your-migration
-    ```
-4. Define Migration:
-    Edit the generated migration file to include the tables you want to create.
-5. Define Seeder Data:
-    Edit the generated seeder file to include the data you want to insert.
-6. Run the Seeder:
-    ```sh
-    npm run createAllSeeders
-    ```
-7. Run the Migration:
-    ```sh
-    npm run createAllTables
-    ```
-8. Delete the Seeder:
-    ```sh
-    npm run deleteAllSeeders
-    ```
-9. Delete the Migration:
-    ```sh
-    npm run deleteAllTables
-    ```
-
-
+    ```

package.json

@@ -107,4 +107,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])