@asad_dev/leo-generator 1.6.0

package/README.md

@@ -0,0 +1,486 @@
+# Leo Generate - Enhanced Module Generator (v1.6.0)
+
+A powerful, production-ready module generator for Express.js applications with Mongoose models, automated Postman Cloud sync, and Swagger documentation.
+
+
+## 🚀 Features
+
+### Core Module Generation
+- 📁 Complete folder structure with TypeScript support
+- 🧩 Advanced TypeScript interfaces with nested types
+- 🔄 Mongoose models with complex schema support
+- 🎮 Production-ready Express controllers with pagination
+- 🛠️ Enhanced service layer with error handling
+- 🛣️ RESTful routes with validation middleware
+- ✅ Zod validation with nested object support
+- ✅ Zod validation with nested object support
+- 🎨 Clean and consistent code structure
+- 🚮 Optional file cleanup on delete (with `--file:true`)
+
+### Advanced Field Support
+- 🔣 Enum fields with predefined values
+- 🏗️ Complex nested objects and arrays
+- 📊 Array of objects with defined structures
+- 🔗 ObjectId references with auto-population
+- 📁 File upload handling
+- 🔍 Search and pagination support
+
+### Smart Documentation Generation
+- 📮 **Automatic Postman Collections** - Generate complete API collections
+- ☁️ **Automated Postman Sync** - Automatically sync APIs to Postman Cloud collections
+- 📖 **Swagger Documentation** - Auto-generate OpenAPI 3.0 specs
+- 🔄 **Intelligent Documentation Updates** - Analyzes your code changes and updates docs accordingly
+- 🧠 **Code-Aware Parsing** - Reads both interface and model files for accurate field extraction
+- 📂 **Organized Output** - Separate folders for documentation types
+- ⚡ **Dynamic Values** - Pre-request scripts auto-generate random values for testing
+- ✅ **100% Syntax Support** - Handles ALL field types the generator can create
+
+## 📦 Installation
+
+```bash
+npm install @asad_dev/leo-generator --global
+```
+
+Or use with npx:
+
+```bash
+npx leo-generate
+```
+
+## 🎯 Quick Start
+
+### Basic Module Generation
+
+```bash
+# Primary command (recommended)
+leo-generate generate User name:string email:string age:number
+
+# Short alias
+leo-generate g User name:string email:string
+
+# Legacy support (still works)
+leo-generate User name:string email:string age:number
+```
+
+## 📋 **Quick Command Reference**
+
+| Command | Purpose | Example |
+|---------|---------|---------|
+| `generate <name> [fields...]` | Create new module | `leo-generate generate User name:string email:string` |
+| `g <name> [fields...]` | Short alias for generate | `leo-generate g Product name:string price:number` |
+| `update-docs` | Update all documentation | `leo-generate update-docs` |
+| `docs` | Short alias for update-docs | `leo-generate docs` |
+| `<name> [fields...]` | Legacy syntax | `leo-generate User name:string email:string` |
+
+### **Common Options**
+- `--no-postman` - Skip Postman collection generation
+- `--no-swagger` - Skip Swagger documentation generation  
+- `--postman-dir <path>` - Custom Postman output directory
+- `--swagger-file <path>` - Custom Swagger file path
+- `--modules-dir <path>` - Custom modules directory
+
+This creates:
+
+```
+src/app/modules/user/
+├── user.interface.ts   // Enhanced TypeScript interfaces
+├── user.model.ts      // Mongoose model with validation
+├── user.controller.ts // Production-ready controllers
+├── user.service.ts    // Enhanced service layer
+├── user.route.ts      // RESTful routes
+├── user.validation.ts // Zod validation schemas
+└── user.constants.ts  // Constants
+
+postman/
+└── user.postman_collection.json  // Auto-generated Postman collection
+
+swagger.json  // Updated with new endpoints
+```
+
+## 🛠️ Commands
+
+### Generate Module
+```bash
+leo-generate generate <ModuleName> [fields...] [options]
+
+# Options:
+--no-postman          # Skip Postman collection generation
+--no-swagger          # Skip Swagger documentation
+--postman-dir <path>  # Custom Postman output directory
+--swagger-file <path> # Custom Swagger file path
+--modules-dir <path>  # Custom modules directory
+--routes-file <path>  # Custom routes file
+--file:true           # Enable file upload support (generates async cleanup helpers)
+--skip <files...>     # Skip specific file types (e.g., interface model constants)
+```
+
+### Smart Documentation Updates
+```bash
+# Intelligently updates documentation for all existing modules
+leo-generate update-docs
+
+# Aliases:
+leo-generate docs
+
+# The system automatically:
+# ✅ Scans all modules in your project
+# ✅ Reads both interface and model files  
+# ✅ Extracts current field definitions
+# ✅ Generates accurate Postman collections
+# ✅ Updates Swagger documentation
+# ✅ Handles complex nested structures
+# ✅ Preserves enum values and references
+
+# Options:
+--modules-dir <path>  # Path to modules directory
+--no-postman          # Skip Postman updates
+--no-swagger          # Skip Swagger updates
+--postman-dir <path>  # Custom Postman output directory
+--swagger-file <path> # Custom Swagger file path
+```
+
+## 🏗️ Advanced Examples
+
+### Complex Nested Structures
+
+```bash
+# E-commerce Order with nested items
+leo-generate generate Order \
+  customer:objectid:User \
+  items:array:object:name:string:price:number:quantity:number \
+  status:enum[pending,processing,shipped,delivered] \
+  shippingAddress:object:street:string:city:string:zipCode:string \
+  totalAmount:number \
+  createdAt:date
+```
+
+### Blog System with References
+
+```bash
+# Blog post with author reference and tags
+leo-generate generate Post \
+  title!:string \
+  content!:string \
+  author:objectid:User \
+  tags:array:string \
+  status:enum[draft,published,archived] \
+  publishedAt?:date \
+  viewCount:number
+```
+
+### Product Catalog with Variants
+
+```bash
+# Product with multiple variants
+leo-generate generate Product \
+  name!:string \
+  description:string \
+  category:enum[Electronics,Clothing,Books,Home] \
+  variants:array:object:size:string:color:string:price:number:stock:number \
+  images:array:string \
+  isActive:boolean
+```
+
+## 📋 Field Types & Syntax
+
+### Basic Types
+```bash
+name:string          # String field
+age:number           # Number field
+isActive:boolean     # Boolean field
+createdAt:date       # Date field
+```
+
+### Modifiers
+```bash
+name!:string         # Required field
+email?:string        # Optional field
+```
+
+### Enums
+```bash
+status:enum[active,inactive,pending]
+role:enum[admin,user,moderator]
+```
+
+### References
+```bash
+author:objectid:User              # Single reference
+categories:array:objectid:Category # Array of references
+```
+
+### Complex Structures
+```bash
+# Array of objects
+items:array:object:name:string:price:number:quantity:number
+
+# Nested object
+address:object:street:string:city:string:country:string
+
+# Mixed arrays
+tags:array:string
+scores:array:number
+```
+
+## 🎮 Generated API Features
+
+### Enhanced Controllers
+- ✅ Pagination support with meta information
+- 🔍 Search functionality across string fields
+- 📊 Sorting with customizable fields
+- 🛡️ Input validation and sanitization
+- 📁 File upload handling
+- ⚡ Error handling with proper HTTP status codes
+
+### Production-Ready Services
+- 🔒 ObjectId validation
+- 🔄 Auto-population of references
+- 🗑️ Proper file cleanup on deletion
+- 📈 Optimized queries with lean()
+- 🔍 Advanced search with regex
+- 📊 Aggregation support
+
+### API Endpoints
+For a module named "Product":
+
+```
+POST   /api/v1/products              # Create product
+GET    /api/v1/products              # Get all (with pagination, search, sort)
+GET    /api/v1/products/:id          # Get single product
+PATCH  /api/v1/products/:id          # Update product
+DELETE /api/v1/products/:id          # Delete product
+
+Query Parameters for GET /api/v1/products:
+?page=1&limit=10&search=keyword&sortBy=createdAt&sortOrder=desc
+```
+
+## 📮 Postman Integration
+
+### Auto-Generated Collections
+- 🔄 Complete CRUD operations
+- 📝 Sample request bodies with realistic data
+- 🔗 Environment variables for base URL
+- 📊 Proper HTTP methods and headers
+- 🎯 Parameter examples for all endpoints
+
+### Collection Structure
+```json
+{
+  "info": {
+    "name": "Product API",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+  },
+  "item": [
+    {
+      "name": "Create Product",
+      "request": {
+        "method": "POST",
+        "body": {
+          "mode": "raw",
+          "raw": "{\n  \"name\": \"sample_name\",\n  \"price\": 123\n}"
+        }
+      }
+    }
+  ]
+}
+```
+
+## ☁️ Automated Postman Cloud Sync
+
+Leo Generate can automatically sync your generated collections to the Postman Cloud.
+
+### Configuration
+Update your `.env` file or `package.json` with your Postman credentials:
+
+```env
+POSTMAN_API_KEY=your_api_key
+POSTMAN_COLLECTION_ID=your_collection_uid
+```
+
+### How it Works
+1. When you run `generate` or `update-docs`, the system checks for credentials.
+2. It fetches your existing collection from Postman Cloud.
+3. It intelligently merges the new/updated module folder into the collection.
+4. It updates the cloud collection via the Postman API.
+
+## 🗑️ Intelligent File Cleanup
+
+When generating a module with `--file:true`, the system adds asynchronous cleanup logic:
+
+- **Service Layer**: Automatically `await`s file removal on record deletion or creation failure.
+- **Helper Utility**: Generates a robust `removeFile` helper using `fs/promises`.
+- **Path Logic**: Automatically handles `/images/` prefix and path normalization.
+
+### Auto-Generated Documentation
+- 📋 OpenAPI 3.0 specification
+- 🏷️ Proper tags and descriptions
+- 📝 Request/response schemas
+- 🔍 Parameter documentation
+- ✅ Validation rules included
+- 🔄 Automatic updates on module changes
+
+### Schema Generation
+```yaml
+components:
+  schemas:
+    Product:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: MongoDB ObjectId
+        name:
+          type: string
+          description: name field
+        price:
+          type: number
+          description: price field
+        createdAt:
+          type: string
+          format: date-time
+      required:
+        - _id
+        - name
+```
+
+## ⚙️ Configuration
+
+### Via package.json
+```json
+{
+  "moduleGenerator": {
+    "modulesDir": "src/app/modules",
+    "routesFile": "src/routes/index.ts"
+  }
+}
+```
+
+### Via CLI Options
+```bash
+leo-generate generate User name:string \
+  --modules-dir src/modules \
+  --routes-file src/routes.ts \
+  --postman-dir collections \
+  --swagger-file api-docs.json
+```
+
+## 🧠 Enhanced Documentation Intelligence (v1.2.0)
+
+### **Code-Aware Documentation Updates**
+The enhanced system now intelligently analyzes your code changes:
+
+```bash
+# Example: You modify an Order model
+# BEFORE: items had name, price, quantity
+# AFTER: items only have name (removed price, quantity)
+
+# Simply run:
+leo-generate update-docs
+
+# The system will:
+# ✅ Read your modified interface and model files
+# ✅ Detect that items now only have 'name' field
+# ✅ Update Postman collections: {"items": [{"name": "sample_name"}]}
+# ✅ Update Swagger schemas to reflect current structure
+# ✅ Handle ALL field types: enums, arrays, nested objects, references
+```
+
+### **100% Syntax Support**
+Every field type the generator can create is fully supported in updates:
+
+| Syntax | Generated Sample | Update Support |
+|--------|------------------|----------------|
+| `name:string` | `"name": "sample_name"` | ✅ Perfect |
+| `age:number` | `"age": 123` | ✅ Perfect |
+| `tags:array:string` | `"tags": ["sample_item"]` | ✅ Perfect |
+| `scores:array:number` | `"scores": [123]` | ✅ Perfect |
+| `status:enum[active,inactive]` | `"status": "active"` | ✅ Perfect |
+| `author:objectid:User` | `"author": "507f1f77..."` | ✅ Perfect |
+| `items:array:object:name:string:price:number` | `"items": [{"name": "...", "price": 123}]` | ✅ Perfect |
+
+## 🔄 Migration from v1.1
+
+The new version maintains backward compatibility:
+
+```bash
+# Old way (still works)
+leo-generate User name:string email:string
+
+# New way (recommended)
+leo-generate generate User name:string email:string
+
+# Enhanced documentation updates
+leo-generate update-docs
+```
+
+## 🎯 Best Practices
+
+### Module Design
+1. Use singular names for modules (e.g., "User" not "Users")
+2. Mark required fields with "!" suffix
+3. Use descriptive field names
+4. Group related fields logically
+5. Consider using enums for status fields
+
+### Field Naming
+```bash
+# Good
+leo-generate generate User name!:string email!:string status:enum[active,inactive]
+
+# Avoid
+leo-generate generate Users NAME:string Email:string stat:string
+```
+
+### Complex Structures
+```bash
+# Prefer structured objects over loose data
+leo-generate generate Order \
+  items:array:object:productId:objectid:Product:quantity:number:price:number \
+  # Instead of: items:array:string
+```
+
+## 🚀 Performance Features
+
+### Optimized Queries
+- 📊 Lean queries for list operations
+- 🔍 Indexed search fields
+- 📈 Aggregation pipeline support
+- 🔄 Efficient population of references
+
+### Caching Ready
+- 🏪 Service layer designed for caching integration
+- 🔑 Consistent data access patterns
+- ⚡ Optimized for Redis integration
+
+## 🛡️ Security Features
+
+### Input Validation
+- ✅ Zod schema validation
+- 🛡️ XSS protection ready
+- 📝 Sanitized inputs
+- 🔒 Type-safe operations
+
+### File Upload Security
+- 📁 Proper file type validation
+- 🗑️ Automatic cleanup on errors
+- 📊 Size limit enforcement ready
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+### Development Setup
+```bash
+git clone <repository>
+cd leo-generator
+npm install
+npm run build
+```
+
+## 📄 License
+
+MIT
+
+---
+
+**Leo Generate** - Because generating quality code should be as smooth as Leo's dribbling! ⚽

package/dist/app/modules/imagemodule/imagemodule.constants.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSetEqual = exports.imagemoduleSearchableFields = exports.imagemoduleFilterables = void 0;
+// Filterable fields for Imagemodule
+exports.imagemoduleFilterables = [];
+// Searchable fields for Imagemodule
+exports.imagemoduleSearchableFields = [];
+// Helper function for set comparison
+const isSetEqual = (setA, setB) => {
+    if (setA.size !== setB.size)
+        return false;
+    for (const item of setA) {
+        if (!setB.has(item))
+            return false;
+    }
+    return true;
+};
+exports.isSetEqual = isSetEqual;

package/dist/app/modules/imagemodule/imagemodule.controller.js

@@ -0,0 +1,98 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImagemoduleController = void 0;
+const imagemodule_service_1 = require("./imagemodule.service");
+const catchAsync_1 = __importDefault(require("../../../shared/catchAsync"));
+const sendResponse_1 = __importDefault(require("../../../shared/sendResponse"));
+const http_status_codes_1 = require("http-status-codes");
+const pick_1 = __importDefault(require("../../../shared/pick"));
+const imagemodule_constants_1 = require("./imagemodule.constants");
+const pagination_1 = require("../../../interfaces/pagination");
+const createImagemodule = (0, catchAsync_1.default)((req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    const _a = req.body, { images, media } = _a, imagemoduleData = __rest(_a, ["images", "media"]);
+    if (images && images.length > 0) {
+        imagemoduleData.images = images;
+    }
+    if (media && media.length > 0) {
+        imagemoduleData.media = media;
+    }
+    const result = yield imagemodule_service_1.ImagemoduleServices.createImagemodule(req.user, imagemoduleData);
+    (0, sendResponse_1.default)(res, {
+        statusCode: http_status_codes_1.StatusCodes.CREATED,
+        success: true,
+        message: 'Imagemodule created successfully',
+        data: result,
+    });
+}));
+const updateImagemodule = (0, catchAsync_1.default)((req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    const { id } = req.params;
+    const imagemoduleData = req.body;
+    const result = yield imagemodule_service_1.ImagemoduleServices.updateImagemodule(id, imagemoduleData);
+    (0, sendResponse_1.default)(res, {
+        statusCode: http_status_codes_1.StatusCodes.OK,
+        success: true,
+        message: 'Imagemodule updated successfully',
+        data: result,
+    });
+}));
+const getSingleImagemodule = (0, catchAsync_1.default)((req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    const { id } = req.params;
+    const result = yield imagemodule_service_1.ImagemoduleServices.getSingleImagemodule(id);
+    (0, sendResponse_1.default)(res, {
+        statusCode: http_status_codes_1.StatusCodes.OK,
+        success: true,
+        message: 'Imagemodule retrieved successfully',
+        data: result,
+    });
+}));
+const getAllImagemodules = (0, catchAsync_1.default)((req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    const filterables = (0, pick_1.default)(req.query, imagemodule_constants_1.imagemoduleFilterables);
+    const pagination = (0, pick_1.default)(req.query, pagination_1.paginationFields);
+    const result = yield imagemodule_service_1.ImagemoduleServices.getAllImagemodules(req.user, filterables, pagination);
+    (0, sendResponse_1.default)(res, {
+        statusCode: http_status_codes_1.StatusCodes.OK,
+        success: true,
+        message: 'Imagemodules retrieved successfully',
+        data: result,
+    });
+}));
+const deleteImagemodule = (0, catchAsync_1.default)((req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    const { id } = req.params;
+    const result = yield imagemodule_service_1.ImagemoduleServices.deleteImagemodule(id);
+    (0, sendResponse_1.default)(res, {
+        statusCode: http_status_codes_1.StatusCodes.OK,
+        success: true,
+        message: 'Imagemodule deleted successfully',
+        data: result,
+    });
+}));
+exports.ImagemoduleController = {
+    createImagemodule,
+    updateImagemodule,
+    getSingleImagemodule,
+    getAllImagemodules,
+    deleteImagemodule,
+};

package/dist/app/modules/imagemodule/imagemodule.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/app/modules/imagemodule/imagemodule.model.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Imagemodule = void 0;
+const mongoose_1 = require("mongoose");
+const imagemoduleSchema = new mongoose_1.Schema({
+    image: { type: String },
+}, {
+    timestamps: true
+});
+exports.Imagemodule = (0, mongoose_1.model)('Imagemodule', imagemoduleSchema);

package/dist/app/modules/imagemodule/imagemodule.route.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImagemoduleRoutes = void 0;
+const express_1 = __importDefault(require("express"));
+const imagemodule_controller_1 = require("./imagemodule.controller");
+const imagemodule_validation_1 = require("./imagemodule.validation");
+const validateRequest_1 = __importDefault(require("../../middleware/validateRequest"));
+const auth_1 = __importDefault(require("../../middleware/auth"));
+const user_1 = require("../../../enum/user");
+const processReqBody_1 = require("../../middleware/processReqBody");
+const router = express_1.default.Router();
+router.get('/', (0, auth_1.default)(user_1.USER_ROLES.SUPER_ADMIN, user_1.USER_ROLES.ADMIN), imagemodule_controller_1.ImagemoduleController.getAllImagemodules);
+router.get('/:id', (0, auth_1.default)(user_1.USER_ROLES.SUPER_ADMIN, user_1.USER_ROLES.ADMIN), imagemodule_controller_1.ImagemoduleController.getSingleImagemodule);
+router.post('/', (0, auth_1.default)(user_1.USER_ROLES.SUPER_ADMIN, user_1.USER_ROLES.ADMIN), (0, processReqBody_1.fileAndBodyProcessorUsingDiskStorage)(), (0, validateRequest_1.default)(imagemodule_validation_1.ImagemoduleValidations.createImagemoduleZodSchema), imagemodule_controller_1.ImagemoduleController.createImagemodule);
+router.patch('/:id', (0, auth_1.default)(user_1.USER_ROLES.SUPER_ADMIN, user_1.USER_ROLES.ADMIN), (0, processReqBody_1.fileAndBodyProcessorUsingDiskStorage)(), (0, validateRequest_1.default)(imagemodule_validation_1.ImagemoduleValidations.updateImagemoduleZodSchema), imagemodule_controller_1.ImagemoduleController.updateImagemodule);
+router.delete('/:id', (0, auth_1.default)(user_1.USER_ROLES.SUPER_ADMIN, user_1.USER_ROLES.ADMIN), imagemodule_controller_1.ImagemoduleController.deleteImagemodule);
+exports.ImagemoduleRoutes = router;