nest-scramble 1.0.0

package/README.md

@@ -0,0 +1,304 @@
+# Nest-Scramble
+
+> Zero-config API Documentation & Postman Generator for NestJS using static analysis
+
+[![npm version](https://badge.fury.io/js/nest-scramble.svg)](https://badge.fury.io/js/nest-scramble)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub stars](https://img.shields.io/github/stars/Eng-MMustafa/nest-scramble.svg)](https://github.com/Eng-MMustafa/nest-scramble)
+[![Author](https://img.shields.io/badge/Author-Mohamed%20Mustafa-blue.svg)](https://github.com/Eng-MMustafa)
+
+## 🚀 Why Nest-Scramble?
+
+As a NestJS developer, I was tired of drowning in `@ApiProperty` decorators just to get basic API documentation. I longed for a zero-config solution where docs just worked without polluting my code. **Nest-Scramble changes that** by using static TypeScript analysis to automatically generate:
+
+- ✅ **OpenAPI 3.0 specifications** from your DTOs
+- ✅ **Postman collections** with smart mock data
+- ✅ **Interactive documentation** with code samples
+- ✅ **Live mocking** for rapid prototyping
+
+**Zero configuration. Zero decorators. Just pure TypeScript.**
+
+## 📖 The Story Behind Nest-Scramble
+
+It all started with a vision: API documentation should be effortless. As a developer passionate about clean code and developer experience, I knew there had to be a better way than manual decorators and runtime reflection.
+
+When I switched to NestJS for its powerful architecture and TypeScript-first approach, I was disappointed by the lack of zero-config documentation tools. Hours wasted on `@ApiProperty({ type: String })` instead of building features.
+
+I knew there had to be a better way. Leveraging my expertise in static analysis and Abstract Syntax Trees (AST), I built Nest-Scramble to bring that same developer experience to the Node.js ecosystem. It's not just a tool—it's my mission to make API documentation as effortless as it should be.
+
+## 🏆 Features Gallery
+
+| Feature | Nest-Scramble | Swagger (@nestjs/swagger) |
+|---------|---------------|---------------------------|
+| Analysis Method | Static AST Traversal | Runtime Reflection |
+| Performance Impact | Zero Overhead | Decorator Runtime Cost |
+| Type Accuracy | Full TypeScript Inference | Partial Mapping |
+| Circular References | Auto-Detected & Resolved | Manual Workarounds |
+| Bundle Size | Minimal | Heavy with Decorators |
+| Code Purity | Zero Decorators | Decorator Pollution |
+| Future Compatibility | TypeScript Evolution Ready | Framework Dependent |
+
+## 🧠 The Vision
+
+Nest-Scramble embodies my engineering philosophy: **Clean Code through Automation**. As a developer who values TypeScript's type safety and NestJS's architecture, I believe that documentation should never compromise code quality.
+
+This library represents a paradigm shift—from manual, error-prone decorators to intelligent, compile-time analysis. It's about empowering developers to focus on building features, not fighting frameworks.
+
+## 🔬 How it's Built
+
+Nest-Scramble is engineered using cutting-edge static analysis techniques that traditional tools cannot match:
+
+- **Abstract Syntax Tree (AST) Traversal**: Direct manipulation of TypeScript's AST using `ts-morph` for unparalleled type inference
+- **Zero-Decorator Architecture**: Pure TypeScript classes remain untouched, preserving domain integrity
+- **Compile-Time Intelligence**: All analysis happens at build-time, eliminating runtime performance costs
+- **Circular Reference Mastery**: Advanced algorithms detect and handle complex type relationships automatically
+
+This approach delivers what runtime reflection simply cannot: perfect accuracy, zero overhead, and future-proof compatibility with TypeScript's evolving type system.
+
+## ⚡ Quick Start (3 Steps)
+
+### 1. Install
+```bash
+npm install nest-scramble
+```
+
+### 2. Import Module
+```typescript
+// app.module.ts
+import { NestScrambleModule } from 'nest-scramble';
+
+@Module({
+  imports: [
+    NestScrambleModule.forRoot({
+      enableMock: true,
+      autoExportPostman: true,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### 3. Visit Documentation
+- **📖 API Docs**: http://localhost:3000/docs
+- **🎭 Live Mocking**: http://localhost:3000/scramble-mock/users
+- **📤 Postman Collection**: Auto-generated at `collection.json`
+
+![Zero-config setup demo](demo.gif)
+
+## ⚙️ Configuration API
+
+```typescript
+NestScrambleModule.forRoot({
+  // Documentation path
+  path: '/docs', // default: '/docs'
+
+  // Enable live mocking
+  enableMock: true, // default: true
+
+  // Auto-export Postman collection
+  autoExportPostman: true, // default: false
+
+  // Output paths
+  postmanOutputPath: 'collection.json',
+  openApiOutputPath: 'openapi.json',
+
+  // API base URL
+  baseUrl: 'http://localhost:3000',
+
+  // Source directory to scan
+  sourcePath: 'src', // default: 'src'
+})
+```
+
+## 🎭 Live Mocking Guide
+
+Nest-Scramble provides **instant API mocking** without writing controllers:
+
+### How It Works
+1. Define your DTOs and controllers normally
+2. Enable `enableMock: true`
+3. All requests to `/scramble-mock/*` return smart mock data
+
+### Example
+
+**Controller:**
+```typescript
+@Controller('users')
+export class UserController {
+  @Get(':id')
+  getUser(@Param('id') id: number): UserDto {
+    // Your logic here
+  }
+}
+```
+
+**Mock Response:**
+```bash
+GET /scramble-mock/users/123
+# Returns: { "id": 123, "name": "John Doe", "email": "john@example.com" }
+```
+
+**Smart Mocking Examples:**
+- `email` → `faker.internet.email()`
+- `name` → `faker.person.fullName()`
+- `createdAt` → `faker.date.recent()`
+- `posts` → Array of mock posts
+
+![Live mocking demo](mock-demo.gif)
+
+## 🔧 Advanced Usage
+
+### CLI Generation
+```bash
+npx nest-scramble generate src --output my-api.json
+```
+
+### Programmatic API
+```typescript
+import { ScannerService, OpenApiTransformer } from 'nest-scramble';
+
+const scanner = new ScannerService();
+const controllers = scanner.scanControllers('src');
+
+const transformer = new OpenApiTransformer();
+const spec = transformer.transform(controllers);
+```
+
+### Watch Mode
+```bash
+npm run watch-generate
+```
+Automatically regenerates docs on file changes.
+
+## 🎨 UI Integration
+
+### Using Scalar UI
+For the modern Scalar documentation UI:
+
+```typescript
+import { ApiReference } from '@scalar/nestjs';
+
+@Module({
+  imports: [
+    NestScrambleModule.forRoot(),
+    ApiReference({
+      path: '/docs',
+      spec: {
+        content: () => {
+          const scanner = new ScannerService();
+          const controllers = scanner.scanControllers('src');
+          const transformer = new OpenApiTransformer();
+          return transformer.transform(controllers);
+        },
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+*Note: If `@scalar/nestjs` is not available, the default HTML UI is served.*
+
+![Scalar UI demo](ui-demo.gif)
+
+## ✅ Supported Features
+
+### Type Analysis
+- ✅ Primitive types (string, number, boolean)
+- ✅ Arrays and nested objects
+- ✅ Union types
+- ✅ Enums
+- ✅ Optional properties
+- ✅ Circular references (auto-detected)
+
+### HTTP Methods
+- ✅ GET, POST, PUT, DELETE, PATCH
+- ✅ Path parameters (@Param)
+- ✅ Query parameters (@Query)
+- ✅ Request bodies (@Body)
+
+### Code Generation
+- ✅ Curl commands
+- ✅ JavaScript Fetch
+- ✅ TypeScript with types
+
+## 🧪 Testing with Demo Controller
+
+The library includes a `DemoController` with complex DTOs:
+
+```typescript
+// Complex DTOs with circular references
+export class UserDto {
+  id: number;
+  name: string;
+  email: string;
+  role: UserRole; // Enum
+  address: AddressDto; // Nested
+  posts: PostDto[]; // Circular reference
+}
+
+export class PostDto {
+  id: number;
+  title: string;
+  content: string;
+  author: UserDto; // Circular reference
+}
+```
+
+Run the demo to verify everything works perfectly.
+
+## 🗺️ Roadmap
+
+- [ ] GraphQL support
+- [ ] Custom mock data providers
+- [ ] Authentication integration
+- [ ] API versioning
+- [ ] Performance optimizations
+- [ ] Plugin system for custom analyzers
+
+## 🔧 Troubleshooting
+
+### Common Issues
+
+**TypeScript Path Mapping Issues:**
+If you're using custom `tsconfig` paths, ensure the scanner can resolve them:
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  }
+}
+```
+
+**Circular Reference Errors:**
+Nest-Scramble auto-detects circular references, but if you encounter issues, simplify your DTOs or use interfaces instead of classes.
+
+**Mock Data Not Generating:**
+Ensure `@faker-js/faker` is installed and your property names follow common conventions (e.g., `email`, `name`).
+
+For more help, check the [issues](https://github.com/Eng-MMustafa/nest-scramble/issues) or start a discussion.
+
+## 🤝 Contributing
+
+We welcome contributions! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new features
+4. Submit a pull request
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file.
+
+## ‍💻 About the Author
+
+![Mohamed Mustafa](https://via.placeholder.com/150x150?text=Mohamed+Mustafa)
+
+Mohamed Mustafa is a passionate full-stack developer with a deep love for TypeScript and modern web frameworks. His mission is to build tools that enhance developer experience and eliminate repetitive tasks. When he's not crafting open-source libraries, you'll find him exploring new technologies, contributing to the developer community, or sharing insights through technical writing.
+
+- [GitHub](https://github.com/Eng-MMustafa)
+- [LinkedIn](https://www.linkedin.com/in/engmohammedmustafa/)

package/dist/NestScrambleModule.d.ts

@@ -0,0 +1,16 @@
+/** Nest-Scramble | Developed by Mohamed Mustafa | MIT License **/
+import { DynamicModule, MiddlewareConsumer } from '@nestjs/common';
+export interface NestScrambleOptions {
+    path?: string;
+    enableMock?: boolean;
+    autoExportPostman?: boolean;
+    postmanOutputPath?: string;
+    baseUrl?: string;
+    sourcePath?: string;
+}
+export declare class NestScrambleModule {
+    static forRoot(options?: NestScrambleOptions): DynamicModule;
+    static forRootAsync(options?: NestScrambleOptions): DynamicModule;
+    configure(consumer: MiddlewareConsumer): void;
+}
+//# sourceMappingURL=NestScrambleModule.d.ts.map

package/dist/NestScrambleModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NestScrambleModule.d.ts","sourceRoot":"","sources":["../src/NestScrambleModule.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAyB,MAAM,gBAAgB,CAAC;AAQ1F,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qBACa,kBAAkB;IAC7B,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,mBAAwB,GAAG,aAAa;IAiDhE,MAAM,CAAC,YAAY,CAAC,OAAO,GAAE,mBAAwB,GAAG,aAAa;IAKrE,SAAS,CAAC,QAAQ,EAAE,kBAAkB;CAMvC"}

package/dist/NestScrambleModule.js

@@ -0,0 +1,73 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var NestScrambleModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestScrambleModule = void 0;
+/** Nest-Scramble | Developed by Mohamed Mustafa | MIT License **/
+const common_1 = require("@nestjs/common");
+const PostmanCollectionGenerator_1 = require("./generators/PostmanCollectionGenerator");
+const MockMiddleware_1 = require("./middleware/MockMiddleware");
+const ScannerService_1 = require("./scanner/ScannerService");
+const MockGenerator_1 = require("./utils/MockGenerator");
+const OpenApiTransformer_1 = require("./utils/OpenApiTransformer");
+const DocsController_1 = require("./controllers/DocsController");
+let NestScrambleModule = NestScrambleModule_1 = class NestScrambleModule {
+    static forRoot(options = {}) {
+        const { path = '/docs', enableMock = true, autoExportPostman = false, postmanOutputPath = 'collection.json', baseUrl = 'http://localhost:3000', sourcePath = 'src', } = options;
+        // Scan controllers and generate spec
+        const scanner = new ScannerService_1.ScannerService();
+        const controllers = scanner.scanControllers(sourcePath);
+        const transformer = new OpenApiTransformer_1.OpenApiTransformer(baseUrl);
+        const openApiSpec = transformer.transform(controllers, 'NestJS API', '1.0.0', baseUrl);
+        // Auto export Postman if enabled
+        if (autoExportPostman) {
+            const generator = new PostmanCollectionGenerator_1.PostmanCollectionGenerator(baseUrl);
+            const collection = generator.generateCollection(controllers);
+            require('fs').writeFileSync(postmanOutputPath, JSON.stringify(collection, null, 2));
+        }
+        return {
+            module: NestScrambleModule_1,
+            providers: [
+                ScannerService_1.ScannerService,
+                PostmanCollectionGenerator_1.PostmanCollectionGenerator,
+                OpenApiTransformer_1.OpenApiTransformer,
+                MockGenerator_1.MockGenerator,
+                {
+                    provide: 'NEST_SCRAMBLE_CONTROLLERS',
+                    useValue: controllers,
+                },
+                {
+                    provide: 'NEST_SCRAMBLE_OPENAPI',
+                    useValue: openApiSpec,
+                },
+                {
+                    provide: 'NEST_SCRAMBLE_OPTIONS',
+                    useValue: options,
+                },
+            ],
+            exports: [ScannerService_1.ScannerService, PostmanCollectionGenerator_1.PostmanCollectionGenerator, OpenApiTransformer_1.OpenApiTransformer],
+            controllers: [DocsController_1.DocsController],
+            imports: [],
+        };
+    }
+    static forRootAsync(options = {}) {
+        // Similar to forRoot but with async providers if needed
+        return this.forRoot(options);
+    }
+    configure(consumer) {
+        // Apply mock middleware if enabled
+        consumer
+            .apply(MockMiddleware_1.MockMiddleware)
+            .forRoutes({ path: 'scramble-mock/*', method: common_1.RequestMethod.ALL });
+    }
+};
+exports.NestScrambleModule = NestScrambleModule;
+exports.NestScrambleModule = NestScrambleModule = NestScrambleModule_1 = __decorate([
+    (0, common_1.Module)({})
+], NestScrambleModule);
+//# sourceMappingURL=NestScrambleModule.js.map

package/dist/NestScrambleModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NestScrambleModule.js","sourceRoot":"","sources":["../src/NestScrambleModule.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,kEAAkE;AAClE,2CAA0F;AAC1F,wFAAqF;AACrF,gEAA6D;AAC7D,6DAA0D;AAC1D,yDAAsD;AACtD,mEAAgE;AAChE,iEAA8D;AAYvD,IAAM,kBAAkB,0BAAxB,MAAM,kBAAkB;IAC7B,MAAM,CAAC,OAAO,CAAC,UAA+B,EAAE;QAC9C,MAAM,EACJ,IAAI,GAAG,OAAO,EACd,UAAU,GAAG,IAAI,EACjB,iBAAiB,GAAG,KAAK,EACzB,iBAAiB,GAAG,iBAAiB,EACrC,OAAO,GAAG,uBAAuB,EACjC,UAAU,GAAG,KAAK,GACnB,GAAG,OAAO,CAAC;QAEZ,qCAAqC;QACrC,MAAM,OAAO,GAAG,IAAI,+BAAc,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QACxD,MAAM,WAAW,GAAG,IAAI,uCAAkB,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEvF,iCAAiC;QACjC,IAAI,iBAAiB,EAAE,CAAC;YACtB,MAAM,SAAS,GAAG,IAAI,uDAA0B,CAAC,OAAO,CAAC,CAAC;YAC1D,MAAM,UAAU,GAAG,SAAS,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,OAAO;YACL,MAAM,EAAE,oBAAkB;YAC1B,SAAS,EAAE;gBACT,+BAAc;gBACd,uDAA0B;gBAC1B,uCAAkB;gBAClB,6BAAa;gBACb;oBACE,OAAO,EAAE,2BAA2B;oBACpC,QAAQ,EAAE,WAAW;iBACtB;gBACD;oBACE,OAAO,EAAE,uBAAuB;oBAChC,QAAQ,EAAE,WAAW;iBACtB;gBACD;oBACE,OAAO,EAAE,uBAAuB;oBAChC,QAAQ,EAAE,OAAO;iBAClB;aACF;YACD,OAAO,EAAE,CAAC,+BAAc,EAAE,uDAA0B,EAAE,uCAAkB,CAAC;YACzE,WAAW,EAAE,CAAC,+BAAc,CAAC;YAC7B,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,UAA+B,EAAE;QACnD,wDAAwD;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,SAAS,CAAC,QAA4B;QACpC,mCAAmC;QACnC,QAAQ;aACL,KAAK,CAAC,+BAAc,CAAC;aACrB,SAAS,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,sBAAa,CAAC,GAAG,EAAE,CAAC,CAAC;IACvE,CAAC;CACF,CAAA;AA7DY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,kBAAkB,CA6D9B"}

package/dist/cli.d.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+/** Nest-Scramble | Developed by Mohamed Mustafa | MIT License **/
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,kEAAkE"}

package/dist/cli.js

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+"use strict";
+/** Nest-Scramble | Developed by Mohamed Mustafa | MIT License **/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const PostmanCollectionGenerator_1 = require("./generators/PostmanCollectionGenerator");
+const ScannerService_1 = require("./scanner/ScannerService");
+const program = new commander_1.Command();
+program
+    .name('nest-scramble')
+    .description('Zero-config API Documentation & Postman Generator for NestJS')
+    .version('1.0.0');
+program
+    .command('generate')
+    .description('Generate Postman collection from NestJS project')
+    .argument('<sourcePath>', 'Path to the source directory (e.g., src)')
+    .option('-o, --output <file>', 'Output file path', 'collection.json')
+    .option('-b, --baseUrl <url>', 'Base URL for the API', '{{baseUrl}}')
+    .action(async (sourcePath, options) => {
+    try {
+        console.log('Scanning controllers...');
+        const scanner = new ScannerService_1.ScannerService();
+        const controllers = scanner.scanControllers(sourcePath);
+        if (controllers.length === 0) {
+            console.log('No controllers found.');
+            return;
+        }
+        console.log(`Found ${controllers.length} controllers with ${controllers.reduce((sum, c) => sum + c.methods.length, 0)} methods.`);
+        console.log('Generating Postman collection...');
+        const generator = new PostmanCollectionGenerator_1.PostmanCollectionGenerator(options.baseUrl);
+        const collection = generator.generateCollection(controllers);
+        const outputPath = path.resolve(options.output);
+        fs.writeFileSync(outputPath, JSON.stringify(collection, null, 2));
+        console.log(`Postman collection saved to ${outputPath}`);
+    }
+    catch (error) {
+        console.error('Error:', error);
+        process.exit(1);
+    }
+});
+program.parse();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;AACA,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAElE,yCAAoC;AACpC,uCAAyB;AACzB,2CAA6B;AAC7B,wFAAqF;AACrF,6DAA0D;AAE1D,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,eAAe,CAAC;KACrB,WAAW,CAAC,8DAA8D,CAAC;KAC3E,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO;KACJ,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CAAC,iDAAiD,CAAC;KAC9D,QAAQ,CAAC,cAAc,EAAE,0CAA0C,CAAC;KACpE,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC;KACpE,MAAM,CAAC,qBAAqB,EAAE,sBAAsB,EAAE,aAAa,CAAC;KACpE,MAAM,CAAC,KAAK,EAAE,UAAkB,EAAE,OAA4C,EAAE,EAAE;IACjF,IAAI,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,IAAI,+BAAc,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAExD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACrC,OAAO;QACT,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,SAAS,WAAW,CAAC,MAAM,qBAAqB,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;QAElI,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAChD,MAAM,SAAS,GAAG,IAAI,uDAA0B,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,UAAU,GAAG,SAAS,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAE7D,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAClE,OAAO,CAAC,GAAG,CAAC,+BAA+B,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/controllers/DemoController.d.ts

@@ -0,0 +1,53 @@
+export declare enum UserRole {
+    ADMIN = "admin",
+    USER = "user",
+    MODERATOR = "moderator"
+}
+export declare class AddressDto {
+    street: string;
+    city: string;
+    country: string;
+    zipCode?: string;
+}
+export declare class PostDto {
+    id: number;
+    title: string;
+    content: string;
+    author: UserDto;
+    tags: string[];
+    createdAt: Date;
+    published: boolean;
+}
+export declare class UserDto {
+    id: number;
+    name: string;
+    email: string;
+    role: UserRole;
+    address: AddressDto;
+    posts: PostDto[];
+    isActive: boolean;
+    createdAt: Date;
+}
+export declare class CreateUserDto {
+    name: string;
+    email: string;
+    role?: UserRole;
+    address: AddressDto;
+}
+export declare class UpdateUserDto {
+    name?: string;
+    email?: string;
+    role?: UserRole;
+    address?: AddressDto;
+    isActive?: boolean;
+}
+export declare class DemoController {
+    getUsers(limit?: number, offset?: number): UserDto[];
+    getUser(id: number): UserDto;
+    createUser(createUserDto: CreateUserDto): UserDto;
+    createPostForUser(userId: number, postData: {
+        title: string;
+        content: string;
+    }): PostDto;
+}
+//# sourceMappingURL=DemoController.d.ts.map

package/dist/controllers/DemoController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DemoController.d.ts","sourceRoot":"","sources":["../../src/controllers/DemoController.ts"],"names":[],"mappings":"AAGA,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,SAAS,cAAc;CACxB;AAED,qBAAa,UAAU;IACrB,MAAM,EAAG,MAAM,CAAC;IAChB,IAAI,EAAG,MAAM,CAAC;IACd,OAAO,EAAG,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,OAAO;IAClB,EAAE,EAAG,MAAM,CAAC;IACZ,KAAK,EAAG,MAAM,CAAC;IACf,OAAO,EAAG,MAAM,CAAC;IACjB,MAAM,EAAG,OAAO,CAAC;IACjB,IAAI,EAAG,MAAM,EAAE,CAAC;IAChB,SAAS,EAAG,IAAI,CAAC;IACjB,SAAS,EAAG,OAAO,CAAC;CACrB;AAED,qBAAa,OAAO;IAClB,EAAE,EAAG,MAAM,CAAC;IACZ,IAAI,EAAG,MAAM,CAAC;IACd,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,EAAG,QAAQ,CAAC;IAChB,OAAO,EAAG,UAAU,CAAC;IACrB,KAAK,EAAG,OAAO,EAAE,CAAC;IAClB,QAAQ,EAAG,OAAO,CAAC;IACnB,SAAS,EAAG,IAAI,CAAC;CAClB;AAED,qBAAa,aAAa;IACxB,IAAI,EAAG,MAAM,CAAC;IACd,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAG,UAAU,CAAC;CACtB;AAED,qBAAa,aAAa;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,qBACa,cAAc;IAEzB,QAAQ,CAAiB,KAAK,CAAC,EAAE,MAAM,EAAmB,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE;IAMrF,OAAO,CAAc,EAAE,EAAE,MAAM,GAAG,OAAO;IAMzC,UAAU,CAAS,aAAa,EAAE,aAAa,GAAG,OAAO;IAMzD,iBAAiB,CAAc,MAAM,EAAE,MAAM,EAAU,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO;CAI9G"}

package/dist/controllers/DemoController.js

@@ -0,0 +1,91 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DemoController = exports.UpdateUserDto = exports.CreateUserDto = exports.UserDto = exports.PostDto = exports.AddressDto = exports.UserRole = void 0;
+/** Nest-Scramble | Developed by Mohamed Mustafa | MIT License **/
+const common_1 = require("@nestjs/common");
+var UserRole;
+(function (UserRole) {
+    UserRole["ADMIN"] = "admin";
+    UserRole["USER"] = "user";
+    UserRole["MODERATOR"] = "moderator";
+})(UserRole || (exports.UserRole = UserRole = {}));
+class AddressDto {
+}
+exports.AddressDto = AddressDto;
+class PostDto {
+}
+exports.PostDto = PostDto;
+class UserDto {
+}
+exports.UserDto = UserDto;
+class CreateUserDto {
+}
+exports.CreateUserDto = CreateUserDto;
+class UpdateUserDto {
+}
+exports.UpdateUserDto = UpdateUserDto;
+let DemoController = class DemoController {
+    getUsers(limit, offset) {
+        // This would return an array of users
+        return [];
+    }
+    getUser(id) {
+        // This would return a single user
+        return {};
+    }
+    createUser(createUserDto) {
+        // This would create and return a user
+        return {};
+    }
+    createPostForUser(userId, postData) {
+        // This would create a post for a user
+        return {};
+    }
+};
+exports.DemoController = DemoController;
+__decorate([
+    (0, common_1.Get)(),
+    __param(0, (0, common_1.Query)('limit')),
+    __param(1, (0, common_1.Query)('offset')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, Number]),
+    __metadata("design:returntype", Array)
+], DemoController.prototype, "getUsers", null);
+__decorate([
+    (0, common_1.Get)(':id'),
+    __param(0, (0, common_1.Param)('id')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", UserDto)
+], DemoController.prototype, "getUser", null);
+__decorate([
+    (0, common_1.Post)(),
+    __param(0, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [CreateUserDto]),
+    __metadata("design:returntype", UserDto)
+], DemoController.prototype, "createUser", null);
+__decorate([
+    (0, common_1.Post)(':id/posts'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, Object]),
+    __metadata("design:returntype", PostDto)
+], DemoController.prototype, "createPostForUser", null);
+exports.DemoController = DemoController = __decorate([
+    (0, common_1.Controller)('users')
+], DemoController);
+//# sourceMappingURL=DemoController.js.map

package/dist/controllers/DemoController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DemoController.js","sourceRoot":"","sources":["../../src/controllers/DemoController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kEAAkE;AAClE,2CAA2E;AAE3E,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,mCAAuB,CAAA;AACzB,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,MAAa,UAAU;CAKtB;AALD,gCAKC;AAED,MAAa,OAAO;CAQnB;AARD,0BAQC;AAED,MAAa,OAAO;CASnB;AATD,0BASC;AAED,MAAa,aAAa;CAKzB;AALD,sCAKC;AAED,MAAa,aAAa;CAMzB;AAND,sCAMC;AAGM,IAAM,cAAc,GAApB,MAAM,cAAc;IAEzB,QAAQ,CAAiB,KAAc,EAAmB,MAAe;QACvE,sCAAsC;QACtC,OAAO,EAAE,CAAC;IACZ,CAAC;IAGD,OAAO,CAAc,EAAU;QAC7B,kCAAkC;QAClC,OAAO,EAAa,CAAC;IACvB,CAAC;IAGD,UAAU,CAAS,aAA4B;QAC7C,sCAAsC;QACtC,OAAO,EAAa,CAAC;IACvB,CAAC;IAGD,iBAAiB,CAAc,MAAc,EAAU,QAA4C;QACjG,sCAAsC;QACtC,OAAO,EAAa,CAAC;IACvB,CAAC;CACF,CAAA;AAxBY,wCAAc;AAEzB;IADC,IAAA,YAAG,GAAE;IACI,WAAA,IAAA,cAAK,EAAC,OAAO,CAAC,CAAA;IAAkB,WAAA,IAAA,cAAK,EAAC,QAAQ,CAAC,CAAA;;;;8CAGxD;AAGD;IADC,IAAA,YAAG,EAAC,KAAK,CAAC;IACF,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;;;oCAAc,OAAO;6CAGxC;AAGD;IADC,IAAA,aAAI,GAAE;IACK,WAAA,IAAA,aAAI,GAAE,CAAA;;qCAAgB,aAAa;oCAAG,OAAO;gDAGxD;AAGD;IADC,IAAA,aAAI,EAAC,WAAW,CAAC;IACC,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IAAkB,WAAA,IAAA,aAAI,GAAE,CAAA;;;oCAAgD,OAAO;uDAG5G;yBAvBU,cAAc;IAD1B,IAAA,mBAAU,EAAC,OAAO,CAAC;GACP,cAAc,CAwB1B"}

package/dist/controllers/DocsController.d.ts

@@ -0,0 +1,7 @@
+export declare class DocsController {
+    private openApiSpec;
+    constructor(openApiSpec: any);
+    getDocs(): string;
+    getOpenApiSpec(): any;
+}
+//# sourceMappingURL=DocsController.d.ts.map

package/dist/controllers/DocsController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsController.d.ts","sourceRoot":"","sources":["../../src/controllers/DocsController.ts"],"names":[],"mappings":"AAGA,qBACa,cAAc;IAEU,OAAO,CAAC,WAAW;gBAAX,WAAW,EAAE,GAAG;IAI3D,OAAO;IA2BP,cAAc;CAGf"}