add-nest-auth 1.1.1 → 1.3.0

package/dist/cli.js

@@ -292,6 +292,36 @@ async function promptConfig(detectedORM, detectedDB) {
       message: "Enable rate limiting on auth endpoints? (recommended)",
       default: true
     },
+    {
+      type: "confirm",
+      name: "enableSwagger",
+      message: "Enable Swagger API documentation? (recommended)",
+      default: true
+    },
+    {
+      type: "confirm",
+      name: "generateTests",
+      message: "Generate unit tests? (recommended)",
+      default: true
+    },
+    {
+      type: "confirm",
+      name: "useUsername",
+      message: "Add username field to user?",
+      default: false
+    },
+    {
+      type: "confirm",
+      name: "enableEmailVerification",
+      message: "Enable email verification?",
+      default: false
+    },
+    {
+      type: "confirm",
+      name: "enableResetPassword",
+      message: "Enable forgot/reset password?",
+      default: true
+    },
     {
       type: "confirm",
       name: "useDetectedORM",
@@ -330,6 +360,11 @@ function getDefaultAnswers(detectedORM, detectedDB) {
     accessExpiration: "1h",
     refreshExpiration: "7d",
     enableRateLimiting: true,
+    enableSwagger: true,
+    generateTests: true,
+    useUsername: false,
+    enableEmailVerification: false,
+    enableResetPassword: true,
     useDetectedORM: true,
     database: detectedDB || "postgres",
     autoInstall: true
@@ -344,11 +379,16 @@ function buildConfig(answers, projectName, sourceRoot, detectedORM, detectedDB)
       enabled: answers.enableRBAC,
       roles: answers.roles || []
     },
-    orm: answers.useDetectedORM !== false ? detectedORM : "typeorm",
+    orm: answers.useDetectedORM !== false ? detectedORM : "none",
     database: answers.database || detectedDB || "postgres",
     features: {
       refreshTokens: answers.refreshTokens,
-      rateLimiting: answers.enableRateLimiting
+      rateLimiting: answers.enableRateLimiting,
+      swagger: answers.enableSwagger,
+      unitTests: answers.generateTests,
+      useUsername: answers.useUsername,
+      emailVerification: answers.enableEmailVerification,
+      resetPassword: answers.enableResetPassword
     },
     jwt: {
       secret: generateSecret(),
@@ -357,7 +397,7 @@ function buildConfig(answers, projectName, sourceRoot, detectedORM, detectedDB)
     },
     autoInstall: answers.autoInstall,
     timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-    generatorVersion: "1.1.0"
+    generatorVersion: "1.3.0"
   };
   return config;
 }
@@ -433,7 +473,12 @@ function showSuccess(stats) {
   console.log(`   \u2022 @nestjs/jwt, @nestjs/passport, @nestjs/config`);
   console.log(`   \u2022 passport, passport-jwt, passport-local`);
   console.log(`   \u2022 bcrypt, class-validator, class-transformer`);
-  console.log(`   \u2022 ${stats.dependenciesAdded} packages total`);
+  if (stats.orm === "prisma") {
+    console.log(`   \u2022 @prisma/client, prisma`);
+  }
+  if (stats.swagger) {
+    console.log(`   \u2022 @nestjs/swagger`);
+  }
   console.log();
   console.log(import_chalk.default.bold("\u{1F510} JWT Configuration:"));
   console.log(`   \u2022 Access token: ${stats.jwt.accessExpiration}`);
@@ -446,9 +491,16 @@ function showSuccess(stats) {
   console.log(import_chalk.default.cyan("   1. Review .env file (auto-generated with secure secret)"));
   console.log(import_chalk.default.gray("      # .env.example is also provided as a git-safe reference"));
   console.log();
-  console.log(import_chalk.default.cyan("   2. Create database migration (if using TypeORM)"));
-  console.log(import_chalk.default.gray("      npm run migration:generate -- src/migrations/CreateUserTable"));
-  console.log(import_chalk.default.gray("      npm run migration:run"));
+  if (stats.orm === "prisma") {
+    console.log(import_chalk.default.cyan("   2. Add Prisma schema models (see prisma-schema-additions.prisma)"));
+    console.log(import_chalk.default.gray("      # Copy the models into your prisma/schema.prisma"));
+    console.log(import_chalk.default.gray("      npx prisma migrate dev --name add-auth-models"));
+    console.log(import_chalk.default.gray("      npx prisma generate"));
+  } else {
+    console.log(import_chalk.default.cyan("   2. Create database migration (if using TypeORM)"));
+    console.log(import_chalk.default.gray("      npm run migration:generate -- src/migrations/CreateUserTable"));
+    console.log(import_chalk.default.gray("      npm run migration:run"));
+  }
   console.log();
   console.log(import_chalk.default.cyan("   3. Start your NestJS app"));
   console.log(import_chalk.default.gray("      npm run start:dev"));
@@ -456,10 +508,24 @@ function showSuccess(stats) {
   console.log(import_chalk.default.cyan("   4. Test authentication endpoints"));
   console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/register"));
   console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/login"));
+  console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/change-password (requires JWT)"));
+  if (stats.emailVerification) {
+    console.log(import_chalk.default.gray("      GET  http://localhost:3000/auth/verify-email?token=..."));
+    console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/resend-verification"));
+  }
+  if (stats.resetPassword) {
+    console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/forgot-password"));
+    console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/reset-password"));
+  }
   console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/refresh"));
   console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/logout (requires JWT)"));
   console.log(import_chalk.default.gray("      POST http://localhost:3000/auth/logout-all (requires JWT)"));
   console.log(import_chalk.default.gray("      GET  http://localhost:3000/users/profile (requires JWT)"));
+  if (stats.swagger) {
+    console.log();
+    console.log(import_chalk.default.cyan("   5. View Swagger API documentation"));
+    console.log(import_chalk.default.gray("      http://localhost:3000/api"));
+  }
   console.log();
   console.log(import_chalk.default.bold("\u{1F4D6} Full documentation:"), "src/auth/README.md");
   console.log();
@@ -467,6 +533,9 @@ function showSuccess(stats) {
   console.log("   \u2022 Use @Public() decorator for routes that don't require auth");
   console.log("   \u2022 Use @Roles('Admin') to restrict routes by role");
   console.log("   \u2022 Access current user with @CurrentUser() decorator");
+  if (stats.swagger) {
+    console.log("   \u2022 Visit /api for interactive Swagger documentation");
+  }
   console.log();
 }
 function createSpinner(text) {
@@ -512,6 +581,8 @@ var init_template_engine = __esm({
       registerHelpers() {
         this.handlebars.registerHelper("eq", (a, b) => a === b);
         this.handlebars.registerHelper("ne", (a, b) => a !== b);
+        this.handlebars.registerHelper("or", (a, b) => a || b);
+        this.handlebars.registerHelper("and", (a, b) => a && b);
         this.handlebars.registerHelper("includes", (arr, item) => arr?.includes(item));
         this.handlebars.registerHelper("capitalize", (str) => {
           if (!str) return "";
@@ -751,9 +822,16 @@ var init_generator = __esm({
         plan.push(
           { template: "dto/login.dto.ts.hbs", output: `${config.sourceRoot}/auth/dto/login.dto.ts` },
           { template: "dto/register.dto.ts.hbs", output: `${config.sourceRoot}/auth/dto/register.dto.ts` },
+          { template: "dto/change-password.dto.ts.hbs", output: `${config.sourceRoot}/auth/dto/change-password.dto.ts` },
           { template: "dto/auth-response.dto.ts.hbs", output: `${config.sourceRoot}/auth/dto/auth-response.dto.ts` },
           { template: "dto/create-user.dto.ts.hbs", output: `${config.sourceRoot}/auth/dto/create-user.dto.ts` }
         );
+        if (config.features.resetPassword) {
+          plan.push(
+            { template: "dto/forgot-password.dto.ts.hbs", output: `${config.sourceRoot}/auth/dto/forgot-password.dto.ts` },
+            { template: "dto/reset-password.dto.ts.hbs", output: `${config.sourceRoot}/auth/dto/reset-password.dto.ts` }
+          );
+        }
         plan.push(
           { template: "users/users.module.ts.hbs", output: `${config.sourceRoot}/users/users.module.ts` },
           { template: "users/users.service.ts.hbs", output: `${config.sourceRoot}/users/users.service.ts` },
@@ -769,6 +847,18 @@ var init_generator = __esm({
               output: `${config.sourceRoot}/users/entities/refresh-token.entity.ts`
             });
           }
+        } else if (config.orm === "prisma") {
+          plan.push(
+            { template: "prisma/prisma.service.ts.hbs", output: `${config.sourceRoot}/prisma/prisma.service.ts` },
+            { template: "prisma/prisma.module.ts.hbs", output: `${config.sourceRoot}/prisma/prisma.module.ts` },
+            { template: "prisma/schema.prisma.additions.hbs", output: "prisma-schema-additions.prisma" }
+          );
+        }
+        if (config.features.unitTests) {
+          plan.push(
+            { template: "tests/auth.service.spec.ts.hbs", output: `${config.sourceRoot}/auth/auth.service.spec.ts` },
+            { template: "tests/auth.controller.spec.ts.hbs", output: `${config.sourceRoot}/auth/auth.controller.spec.ts` }
+          );
         }
         plan.push(
           { template: "shared/env.template.hbs", output: ".env.example" },
@@ -850,6 +940,8 @@ var init_ast_updater = __esm({
           if (config.features.refreshTokens) {
             this.addImport("./users/entities/refresh-token.entity", ["RefreshToken"]);
           }
+        } else if (config && config.orm === "prisma") {
+          this.addImport("./prisma/prisma.module", ["PrismaModule"]);
         }
         this.addImport("./auth/auth.module", ["AuthModule"]);
         this.addImport("./users/users.module", ["UsersModule"]);
@@ -916,6 +1008,8 @@ var init_ast_updater = __esm({
         if (config && config.orm === "typeorm" && !existingModules.has("TypeOrmModule")) {
           const entities = config.features.refreshTokens ? "[User, RefreshToken]" : "[User]";
           allElements.push(this.buildTypeOrmConfig(config.database, entities));
+        } else if (config && config.orm === "prisma" && !existingModules.has("PrismaModule")) {
+          allElements.push("PrismaModule");
         }
         if (!existingModules.has("AuthModule")) {
           allElements.push("AuthModule");
@@ -1034,17 +1128,17 @@ var init_main_ts_updater = __esm({
       sourceFile;
       backupPath = null;
       /**
-       * Update main.ts with global guards and validation pipe
+       * Update main.ts with global guards, validation pipe, and optionally Swagger
        */
-      async update() {
+      async update(config) {
         if (!await fs5.pathExists(this.mainTsPath)) {
           throw new Error(`main.ts not found at ${this.mainTsPath}`);
         }
         await this.createBackup();
         try {
           this.sourceFile = this.project.addSourceFileAtPath(this.mainTsPath);
-          this.addImports();
-          this.addGlobalGuardsAndPipes();
+          this.addImports(config);
+          this.addGlobalGuardsAndPipes(config);
           this.sourceFile.formatText();
           await this.sourceFile.save();
         } catch (error) {
@@ -1055,13 +1149,16 @@ var init_main_ts_updater = __esm({
       /**
        * Add necessary imports
        */
-      addImports() {
+      addImports(config) {
         if (!this.sourceFile) {
           throw new Error("Source file not loaded");
         }
         this.addImport("@nestjs/core", ["Reflector"]);
         this.addImport("@nestjs/common", ["ValidationPipe"]);
         this.addImport("./auth/guards/jwt-auth.guard", ["JwtAuthGuard"]);
+        if (config?.features?.swagger) {
+          this.addImport("@nestjs/swagger", ["SwaggerModule", "DocumentBuilder"]);
+        }
       }
       /**
        * Add an import statement if it doesn't exist
@@ -1087,7 +1184,7 @@ var init_main_ts_updater = __esm({
       /**
        * Add global guards and validation pipe to bootstrap function
        */
-      addGlobalGuardsAndPipes() {
+      addGlobalGuardsAndPipes(config) {
         if (!this.sourceFile) return;
         const bootstrapFunc = this.sourceFile.getFunction("bootstrap");
         if (!bootstrapFunc) {
@@ -1113,7 +1210,7 @@ var init_main_ts_updater = __esm({
         if (listenIndex === -1) {
           listenIndex = statements.length;
         }
-        const codeToInsert = [
+        const codeLines = [
           "",
           "// Enable global validation pipe",
           "app.useGlobalPipes(",
@@ -1127,9 +1224,24 @@ var init_main_ts_updater = __esm({
           "// Enable global JWT guard (all routes protected by default)",
           "// Use @Public() decorator on routes that should be accessible without auth",
           "const reflector = app.get(Reflector);",
-          "app.useGlobalGuards(new JwtAuthGuard(reflector));",
-          ""
-        ].join("\n");
+          "app.useGlobalGuards(new JwtAuthGuard(reflector));"
+        ];
+        if (config?.features?.swagger) {
+          codeLines.push(
+            "",
+            "// Swagger API documentation",
+            "const swaggerConfig = new DocumentBuilder()",
+            "  .setTitle('API Documentation')",
+            "  .setDescription('JWT Authentication API')",
+            "  .setVersion('1.0')",
+            "  .addBearerAuth()",
+            "  .build();",
+            "const document = SwaggerModule.createDocument(app, swaggerConfig);",
+            "SwaggerModule.setup('api', app, document);"
+          );
+        }
+        codeLines.push("");
+        const codeToInsert = codeLines.join("\n");
         body.insertStatements(listenIndex, codeToInsert);
       }
       /**
@@ -1236,9 +1348,16 @@ var init_package_updater = __esm({
               break;
           }
         }
+        if (config.orm === "prisma") {
+          dependencies["@prisma/client"] = "^6.0.0";
+          devDependencies["prisma"] = "^6.0.0";
+        }
         if (config.features.rateLimiting) {
           dependencies["@nestjs/throttler"] = "^6.0.0";
         }
+        if (config.features.swagger) {
+          dependencies["@nestjs/swagger"] = "^11.0.0";
+        }
         return { dependencies, devDependencies };
       }
       /**
@@ -1419,7 +1538,7 @@ async function run(cwd = process.cwd(), options = {}) {
   try {
     const { MainTsUpdater: MainTsUpdater2 } = await Promise.resolve().then(() => (init_installer(), installer_exports));
     const mainUpdater = new MainTsUpdater2(projectInfo.mainTsPath);
-    await mainUpdater.update();
+    await mainUpdater.update(config);
     await mainUpdater.cleanupBackup();
     mainSpinner.succeed("Updated main.ts with global JWT guard");
   } catch (error) {
@@ -1460,7 +1579,11 @@ async function run(cwd = process.cwd(), options = {}) {
     jwt: {
       accessExpiration: config.jwt.accessExpiration,
       refreshExpiration: config.features.refreshTokens ? config.jwt.refreshExpiration : void 0
-    }
+    },
+    orm: config.orm,
+    swagger: config.features.swagger,
+    emailVerification: config.features.emailVerification,
+    resetPassword: config.features.resetPassword
   });
   console.log("\u{1F41B} Issues? https://github.com/Islamawad132/add-nest-auth/issues");
   console.log("\u2B50 Like it? https://github.com/Islamawad132/add-nest-auth");