Auth domain refactor

src/app/migrations/2024-09-06-create-api-token-table.ts

@@ -1,4 +1,4 @@
-import ApiToken from "@src/app/models/auth/ApiToken";
+import ApiToken from "@src/core/domains/auth/models/ApiToken";
 import BaseMigration from "@src/core/domains/migrations/base/BaseMigration";
 import { DataTypes } from "sequelize";
 

src/app/migrations/2024-09-06-create-user-table.ts

@@ -22,12 +22,13 @@ export class CreateUserModelMigration extends BaseMigration {
         await this.schema.createTable(this.table, {
             email: DataTypes.STRING,
             hashedPassword: DataTypes.STRING,
-            groups: DataTypes.JSON,
-            roles: DataTypes.JSON,
+            groups: DataTypes.ARRAY(DataTypes.STRING),
+            roles: DataTypes.ARRAY(DataTypes.STRING),
             firstName: stringNullable,
             lastName: stringNullable,
             createdAt: DataTypes.DATE,
             updatedAt: DataTypes.DATE
+
         })
     }
 

src/app/models/auth/User.ts

@@ -1,7 +1,6 @@
-import UserObserver from "@src/app/observers/UserObserver";
-import IUserModel from "@src/core/domains/auth/interfaces/IUserModel";
+import AuthUser from "@src/core/domains/auth/models/AuthUser";
+import UserObserver from "@src/core/domains/auth/observers/UserObserver";
 import { IModelAttributes } from "@src/core/interfaces/IModel";
-import Model from "@src/core/models/base/Model";
 
 /**
  * User structure
@@ -23,7 +22,7 @@ export interface UserAttributes extends IModelAttributes {
  *
  * Represents a user in the database.
  */
-export default class User extends Model<UserAttributes> implements IUserModel {
+export default class User extends AuthUser {
 
     /**
      * Table name
@@ -38,6 +37,7 @@ export default class User extends Model<UserAttributes> implements IUserModel {
         this.setObserverConstructor(UserObserver);
     }
 
+
     /**
      * Guarded fields
      *
@@ -66,16 +66,6 @@ export default class User extends Model<UserAttributes> implements IUserModel {
         'updatedAt',
     ]
 
-    /**
-     * Fields that should be returned as JSON
-     *
-     * These fields will be returned as JSON when the model is serialized.
-     */
-    json = [
-        'groups',
-        'roles'
-    ]
-
     /**
      * Retrieves the fields defined on the model, minus the password field.
      * As this is a temporary field and shouldn't be saved to the database.
@@ -86,38 +76,4 @@ export default class User extends Model<UserAttributes> implements IUserModel {
         return super.getFields().filter(field => !['password'].includes(field));
     }
 
-    /**
-     * Checks if the user has the given role
-     *
-     * @param role The role to check
-     * @returns True if the user has the role, false otherwise
-     */
-    hasRole(roles: string | string[]): boolean {
-        roles = typeof roles === 'string' ? [roles] : roles;
-        const userRoles = this.getAttributeSync('roles') ?? [];
-
-        for(const role of roles) {
-            if(!userRoles.includes(role)) return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Checks if the user has the given role
-     *
-     * @param role The role to check
-     * @returns True if the user has the role, false otherwise
-     */
-    hasGroup(groups: string | string[]): boolean {
-        groups = typeof groups === 'string' ? [groups] : groups;
-        const userGroups = this.getAttributeSync('groups') ?? [];
-
-        for(const group of groups) {
-            if(!userGroups.includes(group)) return false;
-        }
-
-        return true;
-    }
-
 }

src/app/providers/RoutesProvider.ts

@@ -15,7 +15,7 @@ class RoutesProvider extends BaseProvider {
         const httpService = app('http');
 
         // Bind routes
-        httpService.bindRoutes(app('auth').getAuthRoutes())
+        httpService.bindRoutes(app('auth.jwt').getRouter())
         httpService.bindRoutes(healthRoutes);
         httpService.bindRoutes(apiRoutes);
 

src/app/repositories/auth/UserRepository.ts

@@ -1,21 +1,11 @@
 import User from "@src/app/models/auth/User";
-import Repository from "@src/core/base/Repository";
-import IUserModel from "@src/core/domains/auth/interfaces/IUserModel";
-import IUserRepository from "@src/core/domains/auth/interfaces/IUserRepository";
+import AuthUserRepository from '@src/core/domains/auth/repository/UserRepository';
 
-export default class UserRepository extends Repository<IUserModel> implements IUserRepository {
+
+export default class UserRepository extends AuthUserRepository {
 
     constructor() {
         super(User)
     }
-
-    /**
-     * Finds a User by their email address
-     * @param email 
-     * @returns 
-     */
-    public async findOneByEmail(email: string): Promise<IUserModel | null> {
-        return this.query().where('email', email).first()
-    }
 
 }

src/app/routes/api.ts

@@ -1,6 +1,5 @@
 import Route from "@src/core/domains/http/router/Route"
-
-import ExampleController from "../controllers/ExampleController"
+import ExampleController from "@src/app/controllers/ExampleController"
 
 export default Route.group(router => {
 

src/app/validators/user/CreateUserValidator.ts

@@ -1,4 +1,5 @@
-import { auth } from "@src/core/domains/auth/services/AuthService";
+import User from "@src/app/models/auth/User";
+import { queryBuilder } from "@src/core/domains/eloquent/services/EloquentQueryBuilderService";
 import BaseValidator from "@src/core/domains/validator/base/BaseValidator";
 import { ValidatorPayload } from "@src/core/domains/validator/interfaces/IValidator";
 import Joi, { ObjectSchema } from "joi";
@@ -15,8 +16,7 @@ class CreateUserValidator extends BaseValidator {
      */
     async validateEmailAvailability(payload: ValidatorPayload) {
 
-        const repository = auth().getUserRepository();
-        const user = await repository.findOneByEmail(payload.email as string);
+        const user = await queryBuilder(User).where('email', payload.email as string).first();
 
         if(user) {
             this.setErrorMessage({ email: 'User already exists' });

src/config/acl.ts

@@ -0,0 +1,47 @@
+import { IAclConfig } from "@src/core/domains/auth/interfaces/acl/IAclConfig";
+
+// Define available groups
+export const GROUPS = {
+    User: 'group_user',
+    Admin: 'group_admin',
+} as const
+
+// Define available roles
+export const ROLES = {
+    USER: 'role_user',
+    ADMIN: 'role_admin'
+} as const
+
+/**
+ * ACL configuration
+ */
+export const aclConfig: IAclConfig = {
+
+    // Default user group
+    defaultGroup: GROUPS.User,
+
+    // List of groups
+    groups: [
+        {
+            name: GROUPS.User,
+            roles: [ROLES.USER]
+        },
+        {
+            name: GROUPS.Admin,
+            roles: [ROLES.USER, ROLES.ADMIN]
+        }
+    ],
+
+    // List of roles, scopes and other permissions
+    roles: [
+        {
+            name: ROLES.ADMIN,
+            scopes: []
+        },
+        {
+            name: ROLES.USER,
+            scopes: []
+        },
+    ],
+
+}