feat: add OTP verification and admin credentials to .env.example; refactor user ID handling in controllers and models

Author: muneebhashone

packages/create-tbk-app/src/generators/config.generator.ts

@@ -189,6 +189,16 @@ export async function generateEnvExample(
   lines.push('# Response Validation');
   lines.push('RESPONSE_VALIDATION=warn  # strict | warn | off');
 
+  // OTP VERIFICATION
+  lines.push('# OTP Verification');
+  lines.push('OTP_VERIFICATION_ENABLED=false');
+  lines.push('');
+
+  // ADMIN EMAIL AND PASSWORD
+  lines.push('# Admin Email and Password');
+  lines.push('ADMIN_EMAIL=admin@example.com');
+  lines.push('');
+
   const filePath = path.join(targetDir, '.env.example');
   await writeFile(filePath, lines.join('\n'));
 }

packages/create-tbk-app/templates/auth/src/modules/user/user.controller.ts.hbs

@@ -12,6 +12,7 @@ import type {
   CreateSuperAdminResponseSchema,
 } from './user.schema';
 import { createUser, deleteUser, getUsers } from './user.services';
+import { Types } from 'mongoose';
 
 export const handleDeleteUser = async (
   req: Request<MongoIdSchemaType, unknown>,
@@ -71,7 +72,7 @@ export const handleGetUsers = async (
 ) => {
   const { results, paginatorInfo } = await getUsers(
     {
-      id: req.user.sub,
+      id: new Types.ObjectId(req.user.sub),
     },
     req.query,
   );

packages/create-tbk-app/templates/auth/src/modules/user/user.model.ts.hbs

@@ -20,7 +20,6 @@ const SocialAccountSchema = new Schema<SocialAccountInfoType>({
 
 const UserSchema: Schema<UserType> = new Schema(
 	{
-		_id: { type: String, required: true },
 		email: { type: String, unique: true, required: true },
 		avatar: { type: String },
 		username: { type: String, required: true, unique: true },

src/modules/user/user.controller.ts

@@ -4,14 +4,15 @@ import config from '../../config/env';
 import type { ResponseExtended } from '../../types';
 import { successResponse } from '../../utils/response.utils';
 import { generateRandomPassword } from '../../utils/otp.utils';
-import type { 
-  CreateUserSchemaType, 
+import type {
+  CreateUserSchemaType,
   GetUsersSchemaType,
   CreateUserResponseSchema,
   GetUsersResponseSchema,
   CreateSuperAdminResponseSchema,
 } from './user.schema';
 import { createUser, deleteUser, getUsers } from './user.services';
+import { Types } from 'mongoose';
 
 export const handleDeleteUser = async (
   req: Request<MongoIdSchemaType, unknown>,
@@ -71,7 +72,7 @@ export const handleGetUsers = async (
 ) => {
   const { results, paginatorInfo } = await getUsers(
     {
-      id: req.user.sub,
+      id: new Types.ObjectId(req.user.sub),
     },
     req.query,
   );

src/modules/user/user.model.ts

@@ -20,7 +20,6 @@ const SocialAccountSchema = new Schema<SocialAccountInfoType>({
 
 const UserSchema: Schema<UserType> = new Schema(
 	{
-		_id: { type: String, required: true },
 		email: { type: String, unique: true, required: true },
 		avatar: { type: String },
 		username: { type: String, required: true, unique: true },
@@ -41,9 +40,9 @@ const UserSchema: Schema<UserType> = new Schema(
 
 export interface ISocialAccountDocument
 	extends SocialAccountInfoType,
-		Document {}
+	Document { }
 
-export interface IUserDocument extends Document<string>, UserModelType {}
+export interface IUserDocument extends Document<string>, UserModelType { }
 
 const User = mongoose.model<UserType>("User", UserSchema);
 export default User;