create-zhx-monorepo 0.1.0

package/templates/monorepo-starter/server/prisma/generated/models.ts

@@ -0,0 +1,18 @@
+
+/* !!! This is code generated by Prisma. Do not edit directly. !!! */
+/* eslint-disable */
+// biome-ignore-all lint: generated file
+// @ts-nocheck 
+/*
+ * This is a barrel export file for all models and their related types.
+ *
+ * 🟢 You can import this file directly.
+ */
+export type * from './models/User'
+export type * from './models/RoleAssignment'
+export type * from './models/SecuritySetting'
+export type * from './models/BackupCode'
+export type * from './models/RefreshToken'
+export type * from './models/Otp'
+export type * from './models/Notification'
+export type * from './commonInputTypes'

package/templates/monorepo-starter/server/prisma/migrations/20251218164821_init/migration.sql

@@ -0,0 +1,210 @@
+-- CreateEnum
+CREATE TYPE "UserRole" AS ENUM ('admin', 'customer');
+
+-- CreateEnum
+CREATE TYPE "OtpPurpose" AS ENUM ('setPassword', 'resetPassword', 'verifyIdentifier', 'changeIdentifier', 'enableMfa', 'disableMfa', 'verifyMfa');
+
+-- CreateEnum
+CREATE TYPE "OtpType" AS ENUM ('otp', 'token');
+
+-- CreateEnum
+CREATE TYPE "MfaMethod" AS ENUM ('email', 'sms', 'whatsapp', 'authApp');
+
+-- CreateEnum
+CREATE TYPE "NotificationType" AS ENUM ('email', 'sms', 'whatsapp', 'inApp');
+
+-- CreateEnum
+CREATE TYPE "NotificationStatus" AS ENUM ('pending', 'sent', 'failed', 'read');
+
+-- CreateTable
+CREATE TABLE "User" (
+    "id" TEXT NOT NULL,
+    "username" TEXT,
+    "password" TEXT,
+    "firstName" TEXT NOT NULL,
+    "lastName" TEXT,
+    "displayName" TEXT NOT NULL,
+    "imageUrl" TEXT,
+    "email" TEXT,
+    "phone" TEXT,
+    "isEmailVerified" BOOLEAN NOT NULL DEFAULT false,
+    "isPhoneVerified" BOOLEAN NOT NULL DEFAULT false,
+    "lastLoginAt" TIMESTAMP(3),
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "deletedAt" TIMESTAMP(3),
+
+    CONSTRAINT "User_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "RoleAssignment" (
+    "id" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "role" "UserRole" NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "revokedAt" TIMESTAMP(3),
+
+    CONSTRAINT "RoleAssignment_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "SecuritySetting" (
+    "id" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "preferredMfa" "MfaMethod",
+    "recoveryEmail" TEXT,
+    "recoveryPhone" TEXT,
+    "isMfaEnabled" BOOLEAN NOT NULL DEFAULT false,
+    "loginAlerts" BOOLEAN NOT NULL DEFAULT true,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "SecuritySetting_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "BackupCode" (
+    "id" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "code" TEXT NOT NULL,
+    "usedAt" TIMESTAMP(3),
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "expiresAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "BackupCode_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "RefreshToken" (
+    "id" TEXT NOT NULL,
+    "token" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "ip" TEXT NOT NULL,
+    "userAgent" TEXT NOT NULL,
+    "lastUsed" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "expiresAt" TIMESTAMP(3) NOT NULL,
+    "isActive" BOOLEAN NOT NULL DEFAULT true,
+    "blacklisted" BOOLEAN NOT NULL DEFAULT false,
+
+    CONSTRAINT "RefreshToken_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "Otp" (
+    "id" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "purpose" "OtpPurpose" NOT NULL,
+    "type" "OtpType" NOT NULL DEFAULT 'otp',
+    "secret" TEXT NOT NULL,
+    "expiresAt" TIMESTAMP(3) NOT NULL,
+    "usedAt" TIMESTAMP(3),
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "Otp_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "Notification" (
+    "id" TEXT NOT NULL,
+    "userId" TEXT NOT NULL,
+    "type" "NotificationType" NOT NULL,
+    "title" TEXT,
+    "message" TEXT,
+    "purpose" TEXT NOT NULL,
+    "metadata" JSONB,
+    "status" "NotificationStatus" NOT NULL DEFAULT 'pending',
+    "sentAt" TIMESTAMP(3),
+    "readAt" TIMESTAMP(3),
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "Notification_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User_username_key" ON "User"("username");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User_email_key" ON "User"("email");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User_phone_key" ON "User"("phone");
+
+-- CreateIndex
+CREATE INDEX "User_email_idx" ON "User"("email");
+
+-- CreateIndex
+CREATE INDEX "User_phone_idx" ON "User"("phone");
+
+-- CreateIndex
+CREATE INDEX "User_username_idx" ON "User"("username");
+
+-- CreateIndex
+CREATE INDEX "User_email_isEmailVerified_idx" ON "User"("email", "isEmailVerified");
+
+-- CreateIndex
+CREATE INDEX "User_phone_isPhoneVerified_idx" ON "User"("phone", "isPhoneVerified");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "RoleAssignment_userId_role_key" ON "RoleAssignment"("userId", "role");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "SecuritySetting_userId_key" ON "SecuritySetting"("userId");
+
+-- CreateIndex
+CREATE INDEX "SecuritySetting_userId_idx" ON "SecuritySetting"("userId");
+
+-- CreateIndex
+CREATE INDEX "SecuritySetting_isMfaEnabled_idx" ON "SecuritySetting"("isMfaEnabled");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "BackupCode_code_key" ON "BackupCode"("code");
+
+-- CreateIndex
+CREATE INDEX "BackupCode_userId_usedAt_idx" ON "BackupCode"("userId", "usedAt");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "RefreshToken_token_key" ON "RefreshToken"("token");
+
+-- CreateIndex
+CREATE INDEX "RefreshToken_userId_idx" ON "RefreshToken"("userId");
+
+-- CreateIndex
+CREATE INDEX "RefreshToken_expiresAt_idx" ON "RefreshToken"("expiresAt");
+
+-- CreateIndex
+CREATE INDEX "RefreshToken_userId_expiresAt_idx" ON "RefreshToken"("userId", "expiresAt");
+
+-- CreateIndex
+CREATE INDEX "Otp_userId_purpose_idx" ON "Otp"("userId", "purpose");
+
+-- CreateIndex
+CREATE INDEX "Otp_expiresAt_idx" ON "Otp"("expiresAt");
+
+-- CreateIndex
+CREATE INDEX "Notification_userId_idx" ON "Notification"("userId");
+
+-- CreateIndex
+CREATE INDEX "Notification_userId_readAt_idx" ON "Notification"("userId", "readAt");
+
+-- AddForeignKey
+ALTER TABLE "RoleAssignment" ADD CONSTRAINT "RoleAssignment_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "SecuritySetting" ADD CONSTRAINT "SecuritySetting_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "BackupCode" ADD CONSTRAINT "BackupCode_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "RefreshToken" ADD CONSTRAINT "RefreshToken_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Otp" ADD CONSTRAINT "Otp_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE "Notification" ADD CONSTRAINT "Notification_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE CASCADE ON UPDATE CASCADE;

package/templates/monorepo-starter/server/prisma/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (e.g., Git)
+provider = "postgresql"

package/templates/monorepo-starter/server/prisma/schema.prisma

@@ -0,0 +1,193 @@
+// prisma/schema.prisma
+
+generator client {
+  provider = "prisma-client"
+  output   = "./generated"
+}
+
+datasource db {
+  provider = "postgresql"
+}
+
+//
+// ENUMS
+//
+
+enum UserRole {
+  admin
+  customer
+}
+
+enum OtpPurpose {
+  setPassword
+  resetPassword
+  verifyIdentifier
+  changeIdentifier
+  enableMfa
+  disableMfa
+  verifyMfa
+}
+
+enum OtpType {
+  otp
+  token
+}
+
+enum MfaMethod {
+  email
+  sms
+  whatsapp
+  authApp
+}
+
+enum NotificationType {
+  email
+  sms
+  whatsapp
+  inApp
+}
+
+enum NotificationStatus {
+  pending
+  sent
+  failed
+  read
+}
+
+//
+// AUTH MODELS
+//
+
+model User {
+  id          String  @id @default(ulid())
+  username    String? @unique
+  password    String?
+  firstName   String
+  lastName    String?
+  displayName String
+  imageUrl    String?
+
+  // Contact
+  email           String? @unique
+  phone           String? @unique
+  isEmailVerified Boolean @default(false)
+  isPhoneVerified Boolean @default(false)
+
+  // Status
+  lastLoginAt DateTime?
+
+  createdAt DateTime  @default(now())
+  updatedAt DateTime  @updatedAt
+  deletedAt DateTime?
+
+  // Relations
+  refreshTokens   RefreshToken[]
+  otps            Otp[]
+  roles           RoleAssignment[]
+  securitySetting SecuritySetting?
+
+  notifications Notification[]
+  backupCodes   BackupCode[]
+
+  @@index([email])
+  @@index([phone])
+  @@index([username])
+  @@index([email, isEmailVerified])
+  @@index([phone, isPhoneVerified])
+}
+
+model RoleAssignment {
+  id     String   @id @default(ulid())
+  userId String
+  user   User     @relation(fields: [userId], references: [id], onDelete: Cascade)
+  role   UserRole
+
+  createdAt DateTime  @default(now())
+  updatedAt DateTime  @updatedAt
+  revokedAt DateTime?
+
+  @@unique([userId, role])
+}
+
+model SecuritySetting {
+  id     String @id @default(ulid())
+  userId String @unique
+  user   User   @relation(fields: [userId], references: [id], onDelete: Cascade)
+
+  preferredMfa  MfaMethod?
+  recoveryEmail String?
+  recoveryPhone String?
+  isMfaEnabled  Boolean    @default(false)
+  loginAlerts   Boolean    @default(true)
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  @@index([userId])
+  @@index([isMfaEnabled])
+}
+
+model BackupCode {
+  id        String    @id @default(ulid())
+  userId    String
+  user      User      @relation(fields: [userId], references: [id], onDelete: Cascade)
+  code      String    @unique
+  usedAt    DateTime?
+  createdAt DateTime  @default(now())
+  expiresAt DateTime
+
+  @@index([userId, usedAt])
+}
+
+model RefreshToken {
+  id          String   @id @default(ulid())
+  token       String   @unique
+  userId      String
+  user        User     @relation(fields: [userId], references: [id], onDelete: Cascade)
+  ip          String
+  userAgent   String
+  lastUsed    DateTime @default(now())
+  createdAt   DateTime @default(now())
+  expiresAt   DateTime
+  isActive    Boolean  @default(true)
+  blacklisted Boolean  @default(false)
+
+  @@index([userId])
+  @@index([expiresAt])
+  @@index([userId, expiresAt])
+}
+
+model Otp {
+  id        String     @id @default(ulid())
+  userId    String
+  user      User       @relation(fields: [userId], references: [id], onDelete: Cascade)
+  purpose   OtpPurpose
+  type      OtpType    @default(otp)
+  secret    String
+  expiresAt DateTime
+  usedAt    DateTime?
+  createdAt DateTime   @default(now())
+  updatedAt DateTime   @updatedAt
+
+  @@index([userId, purpose])
+  @@index([expiresAt])
+}
+
+model Notification {
+  id        String             @id @default(cuid())
+  userId    String
+  user      User               @relation(fields: [userId], references: [id], onDelete: Cascade)
+  type      NotificationType
+  title     String?
+  message   String?
+  purpose   String
+  metadata  Json?
+  status    NotificationStatus @default(pending)
+  sentAt    DateTime?
+  readAt    DateTime?
+  createdAt DateTime           @default(now())
+  updatedAt DateTime           @updatedAt
+
+  @@index([userId])
+  @@index([userId, readAt])
+}

package/templates/monorepo-starter/server/prisma.config.ts

@@ -0,0 +1,13 @@
+import 'dotenv/config'
+import { defineConfig, env } from "prisma/config";
+
+export default defineConfig({
+  schema: 'prisma/schema.prisma',
+  migrations: { 
+    path: 'prisma/migrations',
+    seed: 'tsx prisma/seed.ts',
+  },
+  datasource: { 
+    url: env("DB_URI") 
+  }
+});

package/templates/monorepo-starter/server/scripts/generate.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Get the name (e.g., "auth") from the argument
+NAME=$1
+
+if [ -z "$NAME" ]; then
+  echo "❌ Please provide a name (e.g., ./generate.sh auth)"
+  exit 1
+fi
+
+# Run NestJS CLI commands
+nest g module $NAME
+nest g service $NAME
+nest g controller $NAME

package/templates/monorepo-starter/server/src/app.module.ts

@@ -0,0 +1,49 @@
+import { Module } from "@nestjs/common";
+import { ConfigModule } from "@nestjs/config";
+import { ScheduleModule } from "@nestjs/schedule";
+import { APP_GUARD, Reflector } from "@nestjs/core";
+import { EnvModule } from "@modules/env/env.module";
+import { validateEnv } from "@schemas/env.schema";
+import { AuthGuard } from "@guards/auth.guard";
+import { AuthModule } from "@modules/auth/auth.module";
+import { TokenModule } from "@modules/token/token.module";
+import { PublicModule } from "@modules/public/public.module";
+import { TokenService } from "@modules/token/token.service";
+import { PrismaModule } from "@modules/prisma/prisma.module";
+import { LoggerModule } from "@modules/logger/logger.module";
+import { SchedulerModule } from "@modules/scheduler/scheduler.module";
+import { NotificationModule } from "@modules/notification/notification.module";
+import { TemplateModule } from "@modules/template/template.module";
+import { AllExceptionsFilter } from "@filters/exceptions.filter";
+import { ResponseInterceptor } from "@/lib/interceptors/response.interceptor";
+
+@Module({
+  imports: [
+    PublicModule,
+    PrismaModule,
+    LoggerModule,
+    EnvModule,
+    AuthModule,
+    TokenModule,
+    TemplateModule,
+    NotificationModule,
+    SchedulerModule,
+    ScheduleModule.forRoot(),
+    ConfigModule.forRoot({
+      isGlobal: true,
+      validate: validateEnv,
+    }),
+  ],
+
+  providers: [
+    {
+      provide: APP_GUARD,
+      useFactory: (tokenService, reflector) =>
+        new AuthGuard(tokenService, reflector),
+      inject: [TokenService, Reflector],
+    },
+    AllExceptionsFilter,
+    ResponseInterceptor,
+  ],
+})
+export class AppModule {}

package/templates/monorepo-starter/server/src/lib/decorators/logger.decorator.ts

@@ -0,0 +1,20 @@
+import { Inject } from "@nestjs/common";
+import { LoggerService } from "@modules/logger/logger.service";
+
+export function InjectLogger(context?: string): PropertyDecorator {
+  return (target: object, propertyKey: string | symbol) => {
+    Inject(LoggerService)(target, propertyKey);
+
+    const originalInit = target.constructor.prototype?.onModuleInit;
+
+    target.constructor.prototype.onModuleInit = function (...args: any[]) {
+      const logger: LoggerService = (this as any)[propertyKey];
+      if (logger && typeof logger.setContext === "function") {
+        const ctx = context || target.constructor.name;
+        logger.setContext(ctx);
+      }
+
+      if (originalInit) return originalInit.apply(this, args);
+    };
+  };
+}

package/templates/monorepo-starter/server/src/lib/decorators/public.decorator.ts

@@ -0,0 +1,4 @@
+import { SetMetadata } from "@nestjs/common";
+
+export const IS_PUBLIC_KEY = "isPublic";
+export const Public = () => SetMetadata(IS_PUBLIC_KEY, true);

package/templates/monorepo-starter/server/src/lib/decorators/roles.decorator.ts

@@ -0,0 +1,5 @@
+import { SetMetadata } from "@nestjs/common";
+import { UserRole } from "@generated/prisma";
+
+export const ROLES_KEY = "roles";
+export const Roles = (...roles: UserRole[]) => SetMetadata(ROLES_KEY, roles);

package/templates/monorepo-starter/server/src/lib/dto/auth.dto.ts

@@ -0,0 +1,64 @@
+import { OtpPurpose, OtpType } from "@generated/prisma";
+import {
+  IsEnum,
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  MinLength,
+} from "class-validator";
+
+export class SignInDto {
+  @IsString()
+  @IsNotEmpty()
+  identifier!: string;
+
+  @IsString()
+  @IsNotEmpty()
+  @MinLength(8)
+  password!: string;
+}
+
+export class SignUpDto extends SignInDto {
+  @IsOptional()
+  @IsString()
+  username?: string;
+
+  @IsString()
+  @IsNotEmpty()
+  firstName!: string;
+
+  @IsOptional()
+  @IsString()
+  lastName?: string;
+}
+
+export class RequestOtpDto {
+  @IsString()
+  @IsNotEmpty()
+  identifier!: string;
+
+  @IsEnum(OtpPurpose)
+  purpose!: OtpPurpose;
+}
+
+export class ValidateOtpDto extends RequestOtpDto {
+  @IsString()
+  @IsNotEmpty()
+  secret!: string;
+
+  @IsOptional()
+  @IsEnum(OtpType)
+  type?: OtpType;
+}
+
+export class ResetPasswordDto extends ValidateOtpDto {
+  @IsString()
+  @IsNotEmpty()
+  newPassword!: string;
+}
+
+export class ChangeIdentifierDto extends ValidateOtpDto {
+  @IsString()
+  @IsNotEmpty()
+  newIdentifier!: string;
+}

package/templates/monorepo-starter/server/src/lib/dto/security-setting.dto.ts

@@ -0,0 +1,21 @@
+import { IsBoolean, IsNotEmpty, IsOptional, IsString } from "class-validator";
+
+export class VerifyBackupCodeDto {
+  @IsNotEmpty()
+  @IsString()
+  code!: string;
+}
+
+export class UpdateSecuritySettingDto {
+  @IsOptional()
+  @IsString()
+  recoveryEmail?: string;
+
+  @IsOptional()
+  @IsString()
+  recoveryPhone?: string;
+
+  @IsOptional()
+  @IsBoolean()
+  loginAlerts?: boolean;
+}

package/templates/monorepo-starter/server/src/lib/filters/exceptions.filter.ts

@@ -0,0 +1,62 @@
+import { LoggerService } from "@modules/logger/logger.service";
+import type { Request, Response } from "express";
+import {
+  Catch,
+  HttpException,
+  HttpStatus,
+  type ExceptionFilter,
+  type ArgumentsHost,
+} from "@nestjs/common";
+import { InjectLogger } from "@decorators/logger.decorator";
+
+@Catch()
+export class AllExceptionsFilter implements ExceptionFilter {
+  @InjectLogger()
+  private readonly logger!: LoggerService;
+
+  catch(exception: any, host: ArgumentsHost) {
+    const ctx = host.switchToHttp();
+    const req = ctx.getRequest<Request>();
+    const res = ctx.getResponse<Response>();
+
+    const status =
+      exception instanceof HttpException
+        ? exception.getStatus()
+        : HttpStatus.INTERNAL_SERVER_ERROR;
+
+    let message: any = "Internal server error";
+
+    if (exception instanceof HttpException) {
+      const res = exception.getResponse();
+
+      if (
+        res &&
+        typeof res === "object" &&
+        "message" in res &&
+        Array.isArray((res as any).message)
+      ) {
+        message = (res as any).message;
+      } else if (typeof res === "string") {
+        message = res;
+      } else if (typeof exception.message === "string") {
+        message = exception.message;
+      }
+    }
+    // if (response.headersSent) return;
+
+    this.logger.error(`❌ Exception caught`, {
+      message: exception.message,
+      stack: exception.stack,
+      status,
+      path: req.url,
+      method: req.method,
+    });
+
+    res.status(status).json({
+      status,
+      data: null,
+      message,
+      success: false,
+    });
+  }
+}