nestjs-prisma-cli 1.0.8 → 1.0.10

package/README.md

@@ -14,6 +14,7 @@ A CLI tool to quickly scaffold a **NestJS + Prisma** project with built-in suppo
 - 📖 Swagger (OpenAPI) setup
 - 🔑 Authentication boilerplate
 - ☁️ AWS S3 integration
+- 📜 Logging via Winston (rotating logs and DB persistence)
 
 Compatible with **Node.js >=18** and **NestJS v10+**.
 
@@ -31,19 +32,20 @@ Once the CLI is installed, you can use the following commands:
 npm install -g nestjs-prisma-cli
 ```
 
-
 ### 2️⃣ Check CLI version
 
 ```bash
 nestgen -v
 ```
+
 # or
+
 ```bash
 nestgen --version
 ```
 
-
 ### 3️⃣ Generate a new project
+
 ```bash
 nestgen
 ```
@@ -61,31 +63,43 @@ Step 3: 🎉 Project ready! Next steps:
 ```
 
 ### Navigate into your project
+
 ```bash
 cd my-app
 ```
+
 ### Update .env
+
 ```bash
 DATABASE_URL="your_database_connection_string"
 ```
+
 ```bash
 npx prisma generate
 ```
+
 ### SQL Databases
+
 ### (PostgreSQL, MySQL, SQLite, CockroachDB, SQLServer)
+
 ```bash
 npx prisma migrate dev --name init
 ```
+
 ### NoSQL Database
+
 ### (MongoDB)
+
 ```bash
 npx prisma db push
 ```
+
 ### Then, follow this
+
 ```bash
 npx ts-node prisma/seed.ts
 ```
+
 ```bash
 npm run start:dev
 ```
-

package/bin/index.js

@@ -56,42 +56,42 @@ model User {
   name      String?
   email     String
   password  String
+  profileUrl String?
   isActive  Boolean  @default(true)
   createdAt DateTime @default(now())
   updatedAt DateTime @updatedAt
   @@map("tbl_user")
 }
+
+model Log {
+  id          String   @id @default(auto()) @map("_id") @db.ObjectId
+  method      String
+  path        String
+  statusCode  Int
+  messageCode String?
+  message     String?
+  headers     Json
+  body        Json?
+  query       Json?
+  duration    Int
+  createdAt   DateTime @default(now())
+
+  @@map("tbl_log")
+}
 `;
   }
 
   try {
     let prismaContent = await fs.readFile(templatePrismaPath, "utf-8");
-    return prismaContent.replace(
-      /datasource\s+db\s*{[^}]*provider\s*=\s*".*"/,
-      `datasource db {\n  provider = "${selectedProvider}"`
-    );
-  } catch {
-    return `generator client {
-  provider = "prisma-client-js"
-}
 
-datasource db {
-  provider = "${selectedProvider}"
-  url      = env("DATABASE_URL")
-}
+    prismaContent = prismaContent.replace(
+      /(datasource\s+db\s*{[^}]*provider\s*=\s*")\w+(")/,
+      `$1${selectedProvider}$2`
+    );
 
-model User {
-  id        Int      @id @default(autoincrement())
-  userId    String   @unique
-  name      String?
-  email     String
-  password  String
-  isActive  Boolean  @default(true)
-  createdAt DateTime @default(now())
-  updatedAt DateTime @updatedAt
-  @@map("tbl_user")
-}
-`;
+    return prismaContent;
+  } catch (err) {
+    throw new Error(`Failed to read Prisma template: ${err.message}`);
   }
 }
 
@@ -141,12 +141,27 @@ async function main() {
     "@aws-sdk/s3-request-presigner",
     "moment",
   ];
-  await execa(pkgManager, ["install", ...coreDeps], { cwd: projectPath, stdio: "inherit" });
 
-  await execa(pkgManager, ["install", "@prisma/client"], { cwd: projectPath, stdio: "inherit" });
-  await execa(pkgManager, ["install", "-D", "prisma"], { cwd: projectPath, stdio: "inherit" });
+  const devDeps = [
+    "prisma",
+    "@types/multer",
+  ];
+  
 
-  console.log(chalk.green("✅ Dependencies installed!"));
+  await execa(pkgManager, ["install", ...coreDeps], {
+    cwd: projectPath,
+    stdio: "inherit",
+  });
+
+  await execa(pkgManager, ["install", "@prisma/client"], {
+    cwd: projectPath,
+    stdio: "inherit",
+  });
+
+  await execa(pkgManager, ["install", "-D", ...devDeps], {
+    cwd: projectPath,
+    stdio: "inherit",
+  });
 
   const templatePath = path.resolve(__dirname, "../template");
   const projectPrismaPath = path.join(projectPath, "prisma/schema.prisma");
@@ -154,7 +169,6 @@ async function main() {
 
   if (await fs.pathExists(templatePath)) {
     await fs.copy(templatePath, projectPath, { overwrite: true });
-    console.log(chalk.green("✅ Template files copied!"));
   }
 
   const providerMap = {
@@ -199,10 +213,9 @@ PORT=3000
   await fs.outputFile(path.join(projectPath, ".env"), envContent);
 
   console.log(chalk.yellow("🎉 Project ready!"));
-  console.log(chalk.green("✅ .env created! Please update DATABASE_URL if necessary before running Prisma commands."));
-  console.log(chalk.cyan(`cd ${projectName}`));
+  console.log(chalk.green("✅ Congratulations! Your project has been created successfully."));
+  console.log(chalk.cyan(`👉 Next steps: cd ${projectName}`));
 
-  console.log(chalk.yellow("🔧 Next steps (run manually):"));
   console.log(chalk.cyan(`1. Generate Prisma Client:`));
   console.log(chalk.cyan(`   npx prisma generate`));
   if (selectedProvider === "mongodb") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-prisma-cli",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "A CLI to generate NestJS + Prisma project boilerplate with Swagger, Auth, and AWS S3 setup",
   "type": "module",
   "main": "bin/index.js",
@@ -28,7 +28,7 @@
   ],
   "author": "Kyaw Soe",
   "license": "MIT",
-  "homepage": "https://github.com/kyawsoe-dev/nestjs-generator-cli/blob/main/README.md",
+  "homepage": "https://github.com/kyawsoe-dev/nestjs-generator-cli#readme",
   "dependencies": {
     "chalk": "^4.1.2",
     "execa": "^9.6.0",

package/template/prisma/schema.prisma

@@ -1,20 +1,37 @@
 generator client {
-    provider = "prisma-client-js"
-  }
+  provider = "prisma-client-js"
+}
 
-  datasource db {
-    provider = "mysql"
-    url      = env("DATABASE_URL")
-  }
+datasource db {
+  provider = "mysql"
+  url      = env("DATABASE_URL")
+}
 
-  model User {
-    id        Int      @id @default(autoincrement())
-    userId    String   @unique
-    name      String?
-    email     String
-    password  String
-    createdAt DateTime @default(now())
-    updatedAt DateTime @updatedAt
-    @@map("tbl_user")
-  }
-  
+model User {
+  id         Int      @id @default(autoincrement())
+  userId     String   @unique
+  name       String?
+  email      String
+  password   String
+  profileUrl String?
+  createdAt  DateTime @default(now())
+  updatedAt  DateTime @updatedAt
+
+  @@map("tbl_user")
+}
+
+model Log {
+  id          Int      @id @default(autoincrement())
+  method      String
+  path        String
+  statusCode  Int
+  messageCode String?
+  message     String?
+  headers     Json
+  body        Json?
+  query       Json?
+  duration    Int
+  createdAt   DateTime @default(now())
+
+  @@map("tbl_log")
+}

package/template/src/app.module.ts

@@ -1,5 +1,5 @@
 import { Module } from '@nestjs/common';
-import { APP_INTERCEPTOR } from '@nestjs/core';
+import { APP_FILTER, APP_INTERCEPTOR } from '@nestjs/core';
 import { APP_GUARD } from '@nestjs/core';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
@@ -7,6 +7,7 @@ import { PrismaModule } from './prisma/prisma.module';
 import {
   HttpResponseInterceptor,
   LoggingInterceptor,
+  HttpExceptionFilter,
 } from './common/http-interceptor/index';
 import { JwtAuthGuard } from './modules/auth/jwt/jwt.guard';
 import { ConfigModule } from '@nestjs/config';
@@ -20,7 +21,7 @@ import { AuthModule } from './modules/auth/auth.module';
     }),
     PrismaModule,
     UserModule,
-    AuthModule
+    AuthModule,
   ],
   controllers: [AppController],
   providers: [
@@ -28,6 +29,10 @@ import { AuthModule } from './modules/auth/auth.module';
       provide: APP_INTERCEPTOR,
       useClass: LoggingInterceptor,
     },
+    {
+      provide: APP_FILTER,
+      useClass: HttpExceptionFilter,
+    },
     {
       provide: APP_INTERCEPTOR,
       useClass: HttpResponseInterceptor,

package/template/src/common/config/index.ts

@@ -0,0 +1,4 @@
+import { MulterConfig } from './multer-config';
+import { SwaggerConfig } from './swagger.config';
+
+export { MulterConfig, SwaggerConfig };

package/template/src/common/config/multer-config.ts

@@ -0,0 +1,11 @@
+import { MulterOptions } from '@nestjs/platform-express/multer/interfaces/multer-options.interface';
+
+export const MulterConfig: MulterOptions = {
+  limits: { fileSize: 10 * 1024 * 1024 },
+  fileFilter: (req, file, cb) => {
+    if (!file.mimetype.match(/^image\/(jpg|jpeg|png|gif)$/)) {
+      return cb(new Error('Only image files are allowed!'), false);
+    }
+    cb(null, true);
+  },
+};

package/template/src/common/config/swagger.config.ts

@@ -0,0 +1,36 @@
+import { writeFileSync } from 'fs';
+import { join } from 'path';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { INestApplication } from '@nestjs/common';
+
+const title = 'API';
+const description = 'API Swagger documentation';
+
+export const SwaggerConfig = (app: INestApplication) => {
+  const options = new DocumentBuilder()
+    .setTitle(title)
+    .setDescription(description)
+    .setVersion('1.0')
+    .addBearerAuth(
+      {
+        type: 'http',
+        scheme: 'bearer',
+        bearerFormat: 'JWT',
+      },
+      'bearerAuth',
+    )
+    .addSecurityRequirements('bearerAuth')
+    .build();
+
+  const document = SwaggerModule.createDocument(app, options);
+
+  const outputPath = join(process.cwd(), 'swagger-openapi-v1.json');
+  writeFileSync(outputPath, JSON.stringify(document, null, 2));
+  console.log(`Swagger JSON saved to ${outputPath}`);
+
+  SwaggerModule.setup('api', app, document, {
+    swaggerOptions: {
+      persistAuthorization: true,
+    },
+  });
+};

package/template/src/common/decorator/index.ts

@@ -0,0 +1,4 @@
+import { Public, IS_PUBLIC_KEY } from './public.decorator';
+import { ResponseMessage } from './response-message.decorator';
+
+export { Public, IS_PUBLIC_KEY, ResponseMessage };

package/template/src/common/decorator/response-message.decorator.ts

@@ -0,0 +1,5 @@
+
+import { SetMetadata } from '@nestjs/common';
+export const RESPONSE_MESSAGE_METADATA = 'responseMessage';
+export const ResponseMessage = (message: string) =>
+  SetMetadata(RESPONSE_MESSAGE_METADATA, message);

package/template/src/common/dto/paginated-response.dto.ts

@@ -5,10 +5,22 @@ export class PaginatedResponseDto<T> {
   total: number;
 
   @ApiProperty()
-  page: number;
+  limit: number;
 
   @ApiProperty()
-  limit: number;
+  currentPage: number;
+
+  @ApiProperty()
+  firstPage: number;
+
+  @ApiProperty()
+  lastPage: number;
+
+  @ApiProperty()
+  nextPage: number | null;
+
+  @ApiProperty()
+  previousPage: number | null;
 
   @ApiProperty({ isArray: true })
   data: T[];

package/template/src/common/dto/pagination.dto.ts

@@ -1,10 +1,12 @@
 import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Transform } from 'class-transformer';
 import { Type } from 'class-transformer';
 import {
   IsInt,
   IsOptional,
   IsString,
   Min,
+  IsIn,
   IsBooleanString,
 } from 'class-validator';
 
@@ -23,6 +25,22 @@ export class PaginationDto {
   @Min(1)
   limit?: number = 20;
 
+  @ApiPropertyOptional({ example: 'id', description: 'Field to sort by' })
+  @IsOptional()
+  @IsString()
+  sortBy?: string;
+
+  @ApiPropertyOptional({
+    example: 'desc',
+    description: 'Sort order: asc or desc',
+  })
+  @IsOptional()
+  @IsIn(['asc', 'desc'])
+  @Transform(({ value }) =>
+    typeof value === 'string' ? value.toLowerCase() : value,
+  )
+  sortOrder?: 'asc' | 'desc';
+
   @ApiPropertyOptional({ example: '', description: 'Search term' })
   @IsOptional()
   @IsString()

package/template/src/common/enums/http-error-type-enum.ts

@@ -0,0 +1,31 @@
+export enum HttpErrorType {
+  BAD_REQUEST = 400,
+  UNAUTHORIZED = 401,
+  PAYMENT_REQUIRED = 402,
+  FORBIDDEN = 403,
+  NOT_FOUND = 404,
+  METHOD_NOT_ALLOWED = 405,
+  NOT_ACCEPTABLE = 406,
+  PROXY_AUTHENTICATION_REQUIRED = 407,
+  REQUEST_TIMEOUT = 408,
+  CONFLICT = 409,
+  GONE = 410,
+  LENGTH_REQUIRED = 411,
+  PRECONDITION_FAILED = 412,
+  PAYLOAD_TOO_LARGE = 413,
+  URI_TOO_LONG = 414,
+  UNSUPPORTED_MEDIA_TYPE = 415,
+  REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+  EXPECTATION_FAILED = 417,
+  I_AM_A_TEAPOT = 418,
+  MISDIRECTED = 421,
+  UNPROCESSABLE_ENTITY = 422,
+  FAILED_DEPENDENCY = 424,
+  TOO_MANY_REQUESTS = 429,
+  INTERNAL_SERVER_ERROR = 500,
+  NOT_IMPLEMENTED = 501,
+  BAD_GATEWAY = 502,
+  SERVICE_UNAVAILABLE = 503,
+  GATEWAY_TIMEOUT = 504,
+  HTTP_VERSION_NOT_SUPPORTED = 505,
+}

package/template/src/common/enums/index.ts

@@ -1,4 +1,5 @@
 import { DBErrorCode } from './db-error-code.enum';
+import { HttpErrorType } from './http-error-type-enum';
 import { MESSAGE_CODE } from './message-code.enum';
 
-export { DBErrorCode, MESSAGE_CODE };
+export { DBErrorCode, MESSAGE_CODE, HttpErrorType };

package/template/src/common/enums/message-code.enum.ts

@@ -5,6 +5,7 @@ export enum MESSAGE_CODE {
   PASSWORD_SUCCESS = 204,
   DATA_NOT_FOUND = 205,
   USER_VERIFY = 206,
+
   WRONG_USER_PW = 401,
   INVALID_USER_ID = 402,
   MISSED_TOKEN = 403,
@@ -16,5 +17,6 @@ export enum MESSAGE_CODE {
   ROUTE_NOT_FOUND = 410,
   REQUEST_FIELD_REQUIRED = 411,
   DELETE_USER = 412,
+  
   SERVER_ERROR = 501,
 }