feat: Adds user role functionality closes #25

Extends the user creation process to include role assignment.
This allows for creating users with different roles (e.g., admin, user).

- Introduces a `role` field in the user data structure and database schema.
- Adds a `role` argument to the `create-user` CLI command.
- Sets a default role of "user" if no role is specified.

The `role` is now included in the user object and database records.

Author: rrd108

src/cli/create-user.ts

@@ -25,16 +25,22 @@ export default defineCommand({
       type: 'string',
       description: 'User password',
       required: true
+    },
+    role: {
+      alias: 'r',
+      type: 'string',
+      description: 'User role (defaults to "user")',
+      default: 'user'
     }
   },
   async run({ args }) {
-    const { email, name, password } = args
+    const { email, name, password, role } = args
 
     const options = await loadOptions()
 
     try {
-      const user = await createUser({ email, name, password }, options)
-      console.log(`[DB:Create User] User created successfully: ${user.email}`)
+      const user = await createUser({ email, name, password, role }, options)
+      console.log(`[DB:Create User] User created successfully: ${user.email} (role: ${user.role})`)
       process.exit(0)
     }
     catch (error) {

src/types.ts

@@ -55,6 +55,7 @@ export interface User {
   email: string
   name: string
   password: string
+  role: string
   created_at: string
   updated_at: string
 }

src/utils/create-users-table.ts

@@ -15,6 +15,7 @@ export const createUsersTable = async (options: ModuleOptions) => {
       email TEXT NOT NULL UNIQUE,
       name TEXT NOT NULL,
       password TEXT NOT NULL,
+      role TEXT NOT NULL DEFAULT 'user',
       created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
       updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
     )
@@ -27,6 +28,7 @@ export const createUsersTable = async (options: ModuleOptions) => {
         email VARCHAR(255) NOT NULL UNIQUE,
         name VARCHAR(255) NOT NULL,
         password VARCHAR(255) NOT NULL,
+        role VARCHAR(32) NOT NULL DEFAULT 'user',
         created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
         updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
       )
@@ -39,11 +41,12 @@ export const createUsersTable = async (options: ModuleOptions) => {
         email VARCHAR(255) NOT NULL UNIQUE,
         name VARCHAR(255) NOT NULL,
         password VARCHAR(255) NOT NULL,
+        role VARCHAR(32) NOT NULL DEFAULT 'user',
         created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP,
         updated_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
       )
     `
   }
 
-  console.log(`[DB:Create ${connectorName} Users Table] Fields: id, email, name, password, created_at, updated_at ✅`)
+  console.log(`[DB:Create ${connectorName} Users Table] Fields: id, email, name, password, role, created_at, updated_at ✅`)
 }

src/utils/user.ts

@@ -6,6 +6,7 @@ interface CreateUserParams {
   email: string
   name: string
   password: string
+  role?: string
 }
 
 /**
@@ -19,14 +20,17 @@ export const createUser = async (userData: CreateUserParams, options: ModuleOpti
   // Hash the password
   const hashedPassword = await bcrypt.hash(userData.password, 10)
 
+  // Set default role if not provided
+  const role = userData.role || 'user'
+
   // Insert the new user
   await db.sql`
-    INSERT INTO {${usersTable}} (email, name, password, created_at, updated_at)
-    VALUES (${userData.email}, ${userData.name}, ${hashedPassword}, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)
+    INSERT INTO {${usersTable}} (email, name, password, role, created_at, updated_at)
+    VALUES (${userData.email}, ${userData.name}, ${hashedPassword}, ${role}, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)
   `
   // Fetch the created user to return it (especially to get the ID and ensure it was created)
   // Exclude password in the return type
-  const result = await db.sql`SELECT id, email, name, created_at, updated_at FROM {${usersTable}} WHERE email = ${userData.email}` as { rows: Array<{ id: number, email: string, name: string, created_at: Date | string, updated_at: Date | string }> }
+  const result = await db.sql`SELECT id, email, name, role, created_at, updated_at FROM {${usersTable}} WHERE email = ${userData.email}` as { rows: Array<{ id: number, email: string, name: string, role: string, created_at: Date | string, updated_at: Date | string }> }
 
   if (result.rows.length === 0) {
     throw new Error('Failed to retrieve created user.')
@@ -39,6 +43,7 @@ export const createUser = async (userData: CreateUserParams, options: ModuleOpti
     id: user.id,
     email: user.email,
     name: user.name,
+    role: user.role,
     created_at: user.created_at instanceof Date ? user.created_at.toISOString() : user.created_at,
     updated_at: user.updated_at instanceof Date ? user.updated_at.toISOString() : user.updated_at
   }
@@ -51,7 +56,7 @@ export const findUserByEmail = async (email: string, options: ModuleOptions): Pr
   const db = await useDb(options)
   const usersTable = options.tables.users
 
-  const result = await db.sql`SELECT * FROM {${usersTable}} WHERE email = ${email}` as { rows: Array<{ id: number, email: string, name: string, password: string, created_at: Date | string, updated_at: Date | string }> }
+  const result = await db.sql`SELECT * FROM {${usersTable}} WHERE email = ${email}` as { rows: Array<{ id: number, email: string, name: string, password: string, role: string, created_at: Date | string, updated_at: Date | string }> }
 
   if (result.rows.length === 0) {
     return null
@@ -65,6 +70,7 @@ export const findUserByEmail = async (email: string, options: ModuleOptions): Pr
     email: user.email,
     name: user.name,
     password: user.password,
+    role: user.role,
     created_at: user.created_at instanceof Date ? user.created_at.toISOString() : user.created_at,
     updated_at: user.updated_at instanceof Date ? user.updated_at.toISOString() : user.updated_at
   }

test/cli.create-user.test.ts

@@ -153,6 +153,39 @@ describe('CLI: Create User', () => {
     await expect(createUser(userData, testOptions)).rejects.toThrow()
   })
 
+  it('should create user with default role', async () => {
+    const userData = {
+      email: 'test@webmania.cc',
+      name: 'Test User',
+      password: 'mypassword123'
+    }
+
+    await createUser(userData, testOptions)
+
+    // Verify user was created with default role
+    const result = await db.sql`SELECT role FROM users WHERE email = ${userData.email}`
+    const user = result.rows?.[0]
+
+    expect(user?.role).toBe('user')
+  })
+
+  it('should create user with custom role', async () => {
+    const userData = {
+      email: 'admin@webmania.cc',
+      name: 'Admin User',
+      password: 'mypassword123',
+      role: 'admin'
+    }
+
+    await createUser(userData, testOptions)
+
+    // Verify user was created with custom role
+    const result = await db.sql`SELECT role FROM users WHERE email = ${userData.email}`
+    const user = result.rows?.[0]
+
+    expect(user?.role).toBe('admin')
+  })
+
   it('should handle empty password', async () => {
     const userData = {
       email: 'test@webmania.cc',

test/utils.user.test.ts

@@ -83,6 +83,7 @@ describe('User Utilities (src/utils/user.ts)', () => {
         id: expect.any(Number),
         email: userData.email,
         name: userData.name,
+        role: 'user',
         created_at: expect.any(String),
         updated_at: expect.any(String)
       })
@@ -95,6 +96,18 @@ describe('User Utilities (src/utils/user.ts)', () => {
       // and the error handling is already tested in the integration tests
       expect(true).toBe(true)
     })
+
+    it('should create user with custom role', async () => {
+      const userData = { email: 'admin@webmania.cc', name: 'Admin User', password: 'password123', role: 'admin' }
+
+      const user = await createUser(userData, testOptions)
+
+      expect(user).toBeDefined()
+      expect(user.email).toBe(userData.email)
+      expect(user.name).toBe(userData.name)
+      expect(user.role).toBe('admin')
+      expect(user).not.toHaveProperty('password')
+    })
   })
 
   describe('findUserByEmail', () => {