@asad_dev/leo-generator 1.6.3 → 1.7.0

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to Leo Generate will be documented in this file.
 
+## [1.7.0] - 2025-12-28
+
+### 🌟 New: Smart Postman Documentation
+- **Intelligent Endpoint Merging**: Manually added endpoints in Postman are now preserved during `update-docs` or new module generation.
+- **Improved Sync Logic**: The generator now merges endpoints instead of overwriting the entire module folder, ensuring manual customizations are never lost.
+- **Cloud & Local Support**: Merge logic works perfectly for both local `.postman_collection.json` files and automated Postman Cloud sync.
+
+### 🚀 New: Postman Export Feature
+- **Pull Collection Command**: Added `pull-postman` (aliases: `pull`, `export`) to fetch your entire collection from Postman Cloud and save it as a local JSON file.
+- **Backup & Portability**: Easily backup your cloud collection or export it for use in other tools with a single command.
+
+### 🛡️ Core Improvements
+- **Console Feedback**: Added detailed logging during the merge process to show which manual endpoints were preserved.
+- **Enhanced Reliability**: Improved error handling for Postman API interactions to prevent data loss.
+
 ## [1.6.0] - 2025-12-28
 
 ### 🌟 New: Asynchronous File Cleanup

package/COMMAND_REFERENCE.md

@@ -134,6 +134,12 @@ leo-generate --version
 | `--postman-dir <path>` | Custom Postman output directory | `postman` | `--postman-dir collections` |
 | `--swagger-file <path>` | Custom Swagger file path | `swagger.json` | `--swagger-file api-spec.json` |
 
+### **Pull-Postman Command Options**
+
+| Option | Description | Default | Example |
+|--------|-------------|---------|---------|
+| `-o, --output <path>` | Custom output file path | `postman/full_collection...` | `-o ./my_collection.json` |
+
 ## 🏗️ **Field Type Syntax**
 
 ### **Basic Types**
@@ -382,6 +388,9 @@ leo-generate generate User name:string --no-postman --no-swagger
 | `<name> [fields...]` | Legacy syntax | Same as generate |
 | `update-docs` | Update all module documentation | Updated Postman + Swagger |
 | `docs` | Alias for update-docs | Same as update-docs |
+| `pull-postman` | Export collection from cloud | Full collection JSON file |
+| `pull` | Alias for pull-postman | Same as pull-postman |
+| `export` | Alias for pull-postman | Same as pull-postman |
 | `--help` | Show help information | Help text |
 | `--version` | Show version information | Version number |
 

package/README.md

@@ -1,4 +1,4 @@
-# Leo Generate - Enhanced Module Generator (v1.6.0)
+# Leo Generate - Enhanced Module Generator (v1.7.0)
 
 A powerful, production-ready module generator for Express.js applications with Mongoose models, automated Postman Cloud sync, and Swagger documentation.
 
@@ -70,6 +70,7 @@ leo-generate User name:string email:string age:number
 | `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` |
+| `pull-postman` | Fetch collection from cloud | `leo-generate pull-postman` |
 | `<name> [fields...]` | Legacy syntax | `leo-generate User name:string email:string` |
 
 ### **Common Options**
@@ -364,6 +365,19 @@ leo-generate generate User name:string \
   --swagger-file api-docs.json
 ```
 
+### Export Full Postman Collection
+```bash
+# Fetches the entire collection from Postman Cloud and saves it locally
+leo-generate pull-postman
+
+# Aliases:
+leo-generate pull
+leo-generate export
+
+# Options:
+-o, --output <path>  # Custom output file path (default: postman/full_collection.postman_collection.json)
+```
+
 ## 🧠 Enhanced Documentation Intelligence (v1.2.0)
 
 ### **Code-Aware Documentation Updates**

package/dist/index.js

@@ -51,6 +51,8 @@ const fieldParser_1 = require("./utils/fieldParser");
 const interfaceGenerator_1 = require("./utils/interfaceGenerator");
 const documentationUpdater_1 = require("./utils/documentationUpdater");
 const helperGenerator_1 = require("./utils/helperGenerator");
+const postmanApi_1 = require("./utils/postmanApi");
+const postmanGenerator_1 = require("./utils/postmanGenerator");
 // Import template generators
 const route_template_1 = require("./templates/route.template");
 const constants_template_1 = require("./templates/constants.template");
@@ -550,6 +552,28 @@ function main() {
                 postmanCollectionId: config.postmanCollectionId
             }, modules);
         }));
+        program
+            .command("pull-postman")
+            .alias("pull")
+            .alias("export")
+            .description("Fetch and save the full Postman collection from the cloud")
+            .option("-o, --output <path>", "Custom output file path", "postman/full_collection.postman_collection.json")
+            .action((options) => __awaiter(this, void 0, void 0, function* () {
+            if (!config.postmanApiKey || !config.postmanCollectionId) {
+                console.error("❌ Postman API Key and Collection ID are required in .env or package.json");
+                return;
+            }
+            try {
+                const collection = yield (0, postmanApi_1.fetchPostmanCollection)({
+                    apiKey: config.postmanApiKey,
+                    collectionId: config.postmanCollectionId
+                });
+                (0, postmanGenerator_1.saveFullPostmanCollection)(collection, options.output);
+            }
+            catch (error) {
+                console.error("❌ Error pulling Postman collection:", error instanceof Error ? error.message : String(error));
+            }
+        }));
         // Legacy support - direct module generation (backward compatibility)
         program
             .argument("[name]", "Module name (legacy support)")

package/dist/utils/postmanApi.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updatePostmanCollectionViaApi = updatePostmanCollectionViaApi;
+exports.fetchPostmanCollection = fetchPostmanCollection;
 /**
  * Updates an existing Postman collection via the Postman API.
  * It fetches the existing collection, finds the folder for the current module,
@@ -70,10 +71,6 @@ function updatePostmanCollectionViaApi(moduleName, newCollectionData, config) {
             // 2. Prepare the new folder for this module
             // The generator creates a collection where 'item' is the list of requests
             const moduleFolderName = `${moduleName} API`;
-            const newModuleFolder = {
-                name: moduleFolderName,
-                item: newCollectionData.item
-            };
             // 3. Update or Add the folder in the existing collection
             if (!collection.item) {
                 collection.item = [];
@@ -81,11 +78,27 @@ function updatePostmanCollectionViaApi(moduleName, newCollectionData, config) {
             const existingFolderIndex = collection.item.findIndex((item) => item.name === moduleFolderName);
             if (existingFolderIndex !== -1) {
                 console.log(`📝 Updating existing folder: ${moduleFolderName} in Postman collection`);
-                collection.item[existingFolderIndex] = newModuleFolder;
+                // Merge logic: keep existing items that aren't being updated
+                const existingFolder = collection.item[existingFolderIndex];
+                const existingItems = existingFolder.item || [];
+                const newItems = newCollectionData.item;
+                // Create a map of new items by name for quick lookup
+                const newItemsMap = new Map(newItems.map((item) => [item.name, item]));
+                // Updated items list:
+                // 1. All new items (will overwrite existing ones with the same name)
+                // 2. Existing items that ARE NOT in the new list (manual endpoints)
+                const manualItems = existingItems.filter((existingItem) => !newItemsMap.has(existingItem.name));
+                if (manualItems.length > 0) {
+                    console.log(`   ✨ Preserving ${manualItems.length} manual endpoints: ${manualItems.map((m) => m.name).join(', ')}`);
+                }
+                collection.item[existingFolderIndex] = Object.assign(Object.assign({}, existingFolder), { item: [...newItems, ...manualItems] });
             }
             else {
                 console.log(`➕ Adding new folder: ${moduleFolderName} to Postman collection`);
-                collection.item.push(newModuleFolder);
+                collection.item.push({
+                    name: moduleFolderName,
+                    item: newCollectionData.item
+                });
             }
             // Debug: Log a snippet of what we are sending
             console.log(`📤 Sending PUT request to Postman API...`);
@@ -111,3 +124,30 @@ function updatePostmanCollectionViaApi(moduleName, newCollectionData, config) {
         }
     });
 }
+/**
+ * Fetches the complete Postman collection from the API.
+ */
+function fetchPostmanCollection(config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { apiKey, collectionId } = config;
+        const url = `https://api.getpostman.com/collections/${collectionId}`;
+        try {
+            console.log(`🚀 Fetching collection from Postman API: ${collectionId}...`);
+            const response = yield fetch(url, {
+                headers: {
+                    "X-Api-Key": apiKey
+                }
+            });
+            if (!response.ok) {
+                const errorData = yield response.json();
+                throw new Error(`Failed to fetch collection: ${JSON.stringify(errorData)}`);
+            }
+            const data = yield response.json();
+            return data.collection;
+        }
+        catch (error) {
+            console.error("❌ Error fetching Postman collection:", error instanceof Error ? error.message : String(error));
+            throw error;
+        }
+    });
+}

package/dist/utils/postmanGenerator.js

@@ -35,6 +35,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generatePostmanCollection = generatePostmanCollection;
 exports.savePostmanCollection = savePostmanCollection;
+exports.saveFullPostmanCollection = saveFullPostmanCollection;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 // Helper to generate Pre-request Script
@@ -220,8 +221,33 @@ function savePostmanCollection(moduleName, collection, outputDir = "postman") {
         fs.mkdirSync(postmanDir, { recursive: true });
     }
     const filePath = path.join(postmanDir, `${camelCaseName.toLowerCase()}.postman_collection.json`);
-    fs.writeFileSync(filePath, JSON.stringify(collection, null, 2));
-    console.log(`✅ Postman collection created: ${filePath}`);
+    let finalCollection = collection;
+    // Check if the file already exists to merge endpoints
+    if (fs.existsSync(filePath)) {
+        try {
+            const existingContent = fs.readFileSync(filePath, "utf-8");
+            const existingCollection = JSON.parse(existingContent);
+            if (existingCollection.item && Array.isArray(existingCollection.item)) {
+                console.log(`🔄 Merging with existing local collection: ${filePath}`);
+                const existingItems = existingCollection.item;
+                const newItems = collection.item;
+                // Create a map of new items by name
+                const newItemsMap = new Map(newItems.map((item) => [item.name, item]));
+                // Keep manual items (those not in the generated set)
+                const manualItems = existingItems.filter((existingItem) => !newItemsMap.has(existingItem.name));
+                if (manualItems.length > 0) {
+                    console.log(`   ✨ Preserving ${manualItems.length} manual endpoints in local file: ${manualItems.map((m) => m.name).join(', ')}`);
+                }
+                // Final items = new generated items + manual items
+                finalCollection = Object.assign(Object.assign({}, collection), { item: [...newItems, ...manualItems] });
+            }
+        }
+        catch (error) {
+            console.warn(`⚠️  Could not parse existing Postman collection at ${filePath}, overwriting instead.`);
+        }
+    }
+    fs.writeFileSync(filePath, JSON.stringify(finalCollection, null, 2));
+    console.log(`✅ Postman collection ${fs.existsSync(filePath) ? 'updated' : 'created'}: ${filePath}`);
 }
 function generateSampleData(fields, prefix = "") {
     const sampleData = {};
@@ -281,3 +307,23 @@ function generateUpdateSampleData(fields) {
 function toCamelCase(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }
+/**
+ * Saves a full Postman collection to a specific file.
+ */
+function saveFullPostmanCollection(collection, outputFilePath = "postman/full_collection.postman_collection.json") {
+    try {
+        const fullPath = path.isAbsolute(outputFilePath)
+            ? outputFilePath
+            : path.join(process.cwd(), outputFilePath);
+        const dir = path.dirname(fullPath);
+        if (!fs.existsSync(dir)) {
+            fs.mkdirSync(dir, { recursive: true });
+        }
+        fs.writeFileSync(fullPath, JSON.stringify({ collection }, null, 2));
+        console.log(`✅ Full Postman collection exported to: ${fullPath}`);
+    }
+    catch (error) {
+        console.error("❌ Error saving full Postman collection:", error instanceof Error ? error.message : String(error));
+        throw error;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asad_dev/leo-generator",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "description": "Enhanced Express module generator with Mongoose models, automated Postman Cloud sync, and Swagger documentation",
   "main": "dist/index.js",
   "bin": {