nest-scramble 3.0.5 → 3.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mohamed Mustafa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -12,7 +12,7 @@
 
 ---
 
-## What's New in v3.0.4
+## What's New in v3.0.6
 
 ### Typed HTTP Client SDK Generation ✨
 
@@ -25,7 +25,7 @@ npx nest-scramble generate src --format client --output ./api-client.ts
 **Generated output (`api-client.ts`):**
 
 ```typescript
-// Auto-generated by nest-scramble v3.0.4 — do not edit manually
+// Auto-generated by nest-scramble v3.0.6 — do not edit manually
 // Re-generate: npx nest-scramble generate src --format client
 
 export class UsersApiClient {
@@ -65,7 +65,7 @@ const users = await client.getUsers(1, 10); // fully typed ✅
 
 No extra runtime packages. Uses native `fetch`. Stays in sync with your controllers by re-running the command.
 
-### Other v3.0.4 changes
+### Other v3.0.6 changes
 
 - Controller-based sidebar grouping is now the default (no config needed)
 - Route param normalisation `:id` → `{id}` for full OpenAPI compliance
@@ -85,7 +85,7 @@ No `@ApiProperty` decorators. No runtime overhead. Nest-Scramble reads your Type
 | Circular references | Auto-detected | Manual workarounds |
 | Performance overhead | Zero | Decorator cost on every request |
 | Postman collection | Built-in | Third-party export |
-| Typed client SDK | ✅ v3.0.4 | ✗ |
+| Typed client SDK | ✅ v3.0.6 | ✗ |
 
 ---
 
@@ -191,7 +191,7 @@ npx nest-scramble generate src -o openapi.json
 # Generate Postman collection
 npx nest-scramble generate src --format postman -o collection.json
 
-# Generate typed TypeScript client (NEW in v3.0.4)
+# Generate typed TypeScript client (NEW in v3.0.4, updated in v3.0.6)
 npx nest-scramble generate src --format client -o api-client.ts
 
 # Custom options
@@ -456,7 +456,7 @@ npm install nest-scramble@latest
 - [x] Live mock server
 - [x] Incremental scanning & watch mode
 - [x] Transitive dependency tracking
-- [x] Typed TypeScript client SDK (v3.0.4)
+- [x] Typed TypeScript client SDK (v3.0.6)
 - [ ] Insomnia / Bruno collection export
 - [ ] `@ScrambleDoc()` lightweight metadata decorator
 - [ ] GraphQL schema support

package/examples/ui-configuration-example.ts

@@ -0,0 +1,49 @@
+/**
+ * UI Configuration Example
+ *
+ * Demonstrates NestScrambleModule setup options for the built-in
+ * documentation interface.
+ */
+
+import { Module } from '@nestjs/common';
+import { NestScrambleModule } from 'nest-scramble';
+
+// ─── Example 1: Minimal setup ────────────────────────────────────────────────
+@Module({
+  imports: [
+    NestScrambleModule.forRoot({
+      path: '/api-docs',
+      enableMock: true,
+    }),
+  ],
+})
+export class AppModule {}
+
+// ─── Example 2: Full configuration ───────────────────────────────────────────
+@Module({
+  imports: [
+    NestScrambleModule.forRoot({
+      path: '/api-docs',
+      apiTitle: 'My API',
+      apiVersion: '1.0.0',
+      enableMock: true,
+      autoExportPostman: true,
+      postmanOutputPath: './postman-collection.json',
+    }),
+  ],
+})
+export class AppFullModule {}
+
+// ─── Example 3: Async configuration (e.g. reading from ConfigService) ────────
+@Module({
+  imports: [
+    NestScrambleModule.forRootAsync({
+      useFactory: () => ({
+        path: '/docs',
+        apiTitle: 'My API',
+        enableMock: process.env.NODE_ENV !== 'production',
+      }),
+    }),
+  ],
+})
+export class AppAsyncModule {}

package/package.json

@@ -1,32 +1,60 @@
 {
   "name": "nest-scramble",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "description": "A next-generation, decorator-free API documentation engine with Postman generation, live mocking, and typed client SDK generation for NestJS 10 and 11, engineered by Mohamed Mustafa",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
     "nest-scramble": "dist/cli.js"
   },
+  "files": [
+    "dist/",
+    "examples/",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Eng-MMustafa/nest-scramble.git"
+  },
+  "homepage": "https://github.com/Eng-MMustafa/nest-scramble#readme",
+  "bugs": {
+    "url": "https://github.com/Eng-MMustafa/nest-scramble/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "rimraf dist && tsc",
     "dev": "tsc --watch",
     "test": "jest",
+    "test:ci": "jest --coverage --coverageReporters=lcov --coverageReporters=text",
     "lint": "eslint src/**/*.ts",
     "lint:fix": "eslint src/**/*.ts --fix",
     "watch-generate": "node scripts/watch-generate.js"
   },
   "keywords": [
     "nestjs",
+    "nestjs-10",
+    "nestjs-11",
     "documentation",
+    "openapi",
+    "swagger",
     "static-analysis",
     "ast",
     "postman",
     "mocking",
+    "typed-client",
+    "sdk-generator",
     "mohamed-mustafa",
     "typescript",
-    "zero-config"
+    "zero-config",
+    "zero-decorator"
   ],
-  "author": "Mohamed Mustafa <https://github.com/Eng-MMustafa>",
+  "author": {
+    "name": "Mohamed Mustafa",
+    "url": "https://github.com/Eng-MMustafa"
+  },
   "license": "MIT",
   "dependencies": {
     "@faker-js/faker": "^8.4.1",

package/UI_FEATURES.md

@@ -1,310 +0,0 @@
-# 🚀 Nest-Scramble UI - World-Class Design Features
-
-**Engineered by Mohamed Mustafa (@Eng-MMustafa)**
-
-## ✨ Overview
-
-The Nest-Scramble documentation UI has been elevated to a **bespoke, futuristic dashboard** that rivals high-end SaaS products. This document outlines all the advanced UI features and customization options.
-
-## 🆕 Latest Documentation Updates
-
-- **Controller-grouped sidebar**: Operations are grouped under their controller name automatically
-- **Collapsible endpoint tree**: Each controller section can be expanded or collapsed in the sidebar
-- **OpenAPI-safe route params**: Routes like `/users/:id` are emitted as `/users/{id}` for compatibility with OpenAPI renderers
-- **Drop-in upgrade path**: Existing projects only need to update the package and restart the app
-
----
-
-## 🎨 Futuristic Theme Features
-
-### **Deep Space Dark Mode**
-- **Background**: `#050505` - Ultra-deep space black
-- **Animated Grid**: Pulsing background grid with subtle opacity animation
-- **Color Palette**:
-  - **Cyber-Cyan**: `#00f2ff` (Primary accent)
-  - **Electric Purple**: `#a855f7` (Secondary accent)
-  - **Gradient Buttons**: Smooth cyan-to-purple gradients
-
-### **Glassmorphism Design**
-- Backdrop blur effects on all cards and panels
-- Semi-transparent borders with subtle glow
-- Layered depth with shadow insets
-- Modern, frosted-glass aesthetic
-
-### **Typography**
-- **Fonts**: 'Inter' and 'Plus Jakarta Sans' via Google Fonts
-- **Headers**: Gradient text with cyan-to-purple color fill
-- **Code Blocks**: 'JetBrains Mono' and 'Fira Code' for optimal readability
-
-### **Sidebar Navigation**
-- Controller names are used as section titles automatically
-- Endpoints render as nested items under each controller
-- Sections are collapsible to keep large APIs easier to scan
-- Search still works across all operations in the grouped tree
-
-### **Interactive Elements**
-- **Buttons**: 
-  - Gradient backgrounds with hover animations
-  - Shimmer effect on hover
-  - Glow shadows with primary color
-  - Smooth lift animation (translateY)
-  
-- **Search Bar**: 
-  - Spotlight-style UI (Cmd+K feel)
-  - Focus state with glowing border
-  - Dark glassmorphic background
-
-- **Code Snippets**: 
-  - Night Owl syntax theme
-  - Rounded corners with subtle borders
-  - Enhanced readability with proper spacing
-
-### **Custom Branding**
-- **Powered by Badge**: Fixed position badge with:
-  - Gradient background
-  - Pulsing glow animation
-  - "✨ Powered by Nest-Scramble" text
-  - Bottom-right placement
-
-### **Scrollbar Styling**
-- Custom gradient scrollbar thumb
-- Smooth hover effects
-- Matches the overall theme aesthetic
-
----
-
-## 🎯 Configuration Options
-
-### **Basic Setup**
-
-```typescript
-import { NestScrambleModule } from 'nest-scramble';
-
-@Module({
-  imports: [
-    NestScrambleModule.forRoot({
-      // Theme selection
-      theme: 'futuristic', // or 'classic'
-      
-      // Primary brand color
-      primaryColor: '#00f2ff',
-      
-      // Custom favicon
-      customDomainIcon: 'https://your-domain.com/favicon.ico',
-      
-      // API metadata
-      apiTitle: 'My Awesome API',
-      apiVersion: '2.0.0',
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-### **Available Options**
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `theme` | `'classic' \| 'futuristic'` | `'futuristic'` | UI theme selection |
-| `primaryColor` | `string` | `'#00f2ff'` | Primary accent color (hex) |
-| `customDomainIcon` | `string` | `''` | Custom favicon URL |
-| `apiTitle` | `string` | Auto-detected | API documentation title |
-| `apiVersion` | `string` | Auto-detected | API version number |
-| `path` | `string` | `'/docs'` | Documentation route path |
-| `enableMock` | `boolean` | `true` | Enable mock server |
-
-### **Upgrade Note**
-
-```bash
-npm install nest-scramble@latest
-```
-
-After updating, restart your NestJS server and open `/docs` again. The grouped sidebar works automatically with existing controllers.
-
----
-
-## 🎭 Easter Egg Features
-
-### **Console Messages**
-When users access the documentation, they'll see beautiful console messages:
-
-```
-✨ Engineered with passion by Mohamed Mustafa
-Nest-Scramble is active.
-🚀 GitHub: https://github.com/Eng-MMustafa/nest-scramble
-```
-
-### **Theme Toggle**
-- Live theme switcher button (top-right)
-- Persists preference in localStorage
-- Smooth transitions between themes
-
----
-
-## 🖥️ Terminal UI Enhancement
-
-### **Gradient Dashboard**
-The startup dashboard now features:
-- **Cyan & Purple** gradient borders
-- **Bold emojis** for visual hierarchy
-- **Color-coded sections**:
-  - 🟢 Green bullets for endpoints
-  - 🔵 Cyan arrows for URLs
-  - 🟡 Yellow icons for metadata
-  - 🟣 Purple for theme indicator
-
-### **Example Output**
-
-```
-╔═══════════════════════════════════════════════════════════════╗
-║  ✨ NEST-SCRAMBLE by Mohamed Mustafa                          ║
-║  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  ║
-║                                                               ║
-║  ● Documentation                                              ║
-║    → http://localhost:3000/docs                               ║
-║                                                               ║
-║  ● OpenAPI Spec                                               ║
-║    → http://localhost:3000/docs-json                          ║
-║                                                               ║
-║  ● Mock Server                                                ║
-║    → http://localhost:3000/scramble-mock                      ║
-║                                                               ║
-║  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  ║
-║  📦 Source Path: src                                          ║
-║  🎯 Controllers: 5                                            ║
-║  🎨 Theme: Futuristic                                         ║
-╚═══════════════════════════════════════════════════════════════╝
-```
-
----
-
-## 🎨 CSS Architecture
-
-### **Futuristic Theme**
-- **Root Variables**: CSS custom properties for easy theming
-- **Animations**: 
-  - `gridPulse`: Background grid animation (10s)
-  - `badgePulse`: Branding badge glow (3s)
-- **Transitions**: Smooth 0.3s cubic-bezier for all interactions
-- **Responsive**: Mobile-optimized with proper viewport settings
-
-### **Classic Theme**
-- Clean, minimal design
-- Light background with dark text
-- Simplified color scheme
-- Professional appearance for conservative environments
-
----
-
-## 🚀 Advanced Features
-
-### **1. Dynamic Color Branding**
-Set your brand color once, and it propagates throughout:
-- Button gradients
-- Focus states
-- Glow effects
-- Scrollbar styling
-- Link colors
-
-### **2. Glassmorphism Effects**
-- `backdrop-filter: blur(20px)` on cards
-- Semi-transparent backgrounds
-- Layered shadows for depth
-- Modern, premium feel
-
-### **3. Code Block Theming**
-- Night Owl color scheme
-- Syntax highlighting support
-- Monospace font optimization
-- Enhanced readability
-
-### **4. Responsive Design**
-- Mobile-first approach
-- Flexible layouts
-- Touch-optimized interactions
-- Adaptive spacing
-
----
-
-## 📊 Performance Optimizations
-
-- **Font Preloading**: Google Fonts with `preconnect`
-- **CSS-only Animations**: No JavaScript overhead
-- **Minimal DOM Manipulation**: Efficient rendering
-- **Optimized Selectors**: Fast CSS matching
-
----
-
-## 🎯 Use Cases
-
-### **Startup/SaaS Products**
-```typescript
-NestScrambleModule.forRoot({
-  theme: 'futuristic',
-  primaryColor: '#00f2ff',
-  apiTitle: 'StartupX API',
-})
-```
-
-### **Enterprise/Corporate**
-```typescript
-NestScrambleModule.forRoot({
-  theme: 'classic',
-  primaryColor: '#0066cc',
-  apiTitle: 'Enterprise API Gateway',
-})
-```
-
-### **Personal Projects**
-```typescript
-NestScrambleModule.forRoot({
-  theme: 'futuristic',
-  primaryColor: '#a855f7',
-  customDomainIcon: '/my-logo.png',
-})
-```
-
----
-
-## 🔥 What Makes This "Dala3" (High-End)?
-
-1. **✨ Attention to Detail**: Every pixel is crafted with care
-2. **🎨 Modern Design Language**: Glassmorphism, gradients, animations
-3. **⚡ Smooth Interactions**: Buttery 60fps animations
-4. **🎯 User Experience**: Intuitive, delightful, professional
-5. **🚀 Performance**: Optimized for speed and efficiency
-6. **💎 Premium Feel**: Rivals products like Stripe, Vercel, Linear
-
----
-
-## 🛠️ Technical Implementation
-
-### **DocsController.ts**
-- Dynamic CSS injection based on theme
-- Separate methods for futuristic and classic themes
-- Easter egg console script injection
-- Theme toggle functionality
-
-### **NestScrambleModule.ts**
-- Enhanced options interface
-- Smart defaults with auto-detection
-- Gradient terminal dashboard
-- Configuration validation
-
----
-
-## 📝 License
-
-MIT License - Developed by **Mohamed Mustafa** (@Eng-MMustafa)
-
----
-
-## 🌟 Credits
-
-**Lead Architect**: Mohamed Mustafa  
-**GitHub**: [@Eng-MMustafa](https://github.com/Eng-MMustafa)  
-**Project**: [nest-scramble](https://github.com/Eng-MMustafa/nest-scramble)
-
----
-
-**Made with ✨ and passion for beautiful developer experiences.**

package/build-and-publish.sh

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-echo "🚀 Building Nest-Scramble v2.1.1..."
-npm run build
-
-echo "📦 Publishing to npm..."
-npm publish
-
-echo "✅ Done!"