nest-scramble 1.4.2 โ†’ 1.4.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -344,28 +344,63 @@ jobs:
344
344
  path: openapi.json
345
345
  ```
346
346
 
347
- ## ๐ŸŽจ Documentation UI - World-Class Design
347
+ ## ๐ŸŽจ Documentation UI - Professional API Dashboard
348
348
 
349
- ### โœจ Futuristic Theme (NEW!)
349
+ ### โœจ Elite Dashboard Design (NEW!)
350
350
 
351
- Nest-Scramble now features a **bespoke, futuristic dashboard** that rivals high-end SaaS products like Stripe, Vercel, and Linear!
351
+ Nest-Scramble features a **professional, high-end API dashboard** inspired by Stripe and Postman, where each request is displayed on a separate page for focused documentation!
352
352
 
353
353
  **๐Ÿš€ Key Features:**
354
- - **Deep Space Dark Mode** - Ultra-premium `#050505` background
355
- - **Glassmorphism Design** - Backdrop blur effects on all cards
356
- - **Cyber Gradients** - Cyan-to-purple button animations
357
- - **Animated Grid Background** - Subtle pulsing effect
358
- - **Night Owl Code Theme** - Beautiful syntax highlighting
359
- - **Custom Scrollbar** - Gradient styling throughout
360
- - **Spotlight Search** - Cmd+K style search experience
361
- - **Easter Egg Console** - Hidden developer messages โœจ
354
+ - **Sidebar-Only Navigation** - Fixed 320px sidebar with controller grouping
355
+ - **Single-Request Per Page** - Each endpoint gets its own dedicated view
356
+ - **Three-Column Elite Layout** - Information | Request Editor | Test Panel
357
+ - **Deep Black Background** - Professional `#000000` and `#0B0E14` theme
358
+ - **Cyber-Cyan Accents** - `#00f2ff` for active states and primary actions
359
+ - **Vibrant HTTP Method Badges** - Color-coded with glow effects:
360
+ - GET = Royal Blue (`#3B82F6`)
361
+ - POST = Emerald Green (`#10B981`)
362
+ - PUT = Amber Orange (`#F59E0B`)
363
+ - PATCH = Violet Purple (`#8B5CF6`)
364
+ - DELETE = Vibrant Red (`#EF4444`)
365
+ - **Glassmorphism Effects** - Backdrop blur on request/response panels
366
+ - **40px Spacious Padding** - Premium whitespace throughout
367
+ - **Terminal-Style Response** - Black box with green text for API responses
368
+ - **High-Contrast Labels** - Required, Type, and Default badges
369
+ - **Custom Scrollbars** - Gradient cyan-to-purple styling
370
+ - **Plus Jakarta Sans Typography** - Modern, professional font family
371
+ - **Powered by Badge** - Animated branding with pulse effect
372
+
373
+ ### ๐Ÿ“ Three-Column Elite Interface
374
+
375
+ The dashboard uses a professional three-column layout for each endpoint:
376
+
377
+ **Column 1 (Left) - Information Panel:**
378
+ - Endpoint title with large, bold typography
379
+ - HTTP method badge with vibrant colors and glow
380
+ - Endpoint description and documentation
381
+ - Clean parameters table with high-contrast labels
382
+ - Type information and required field indicators
383
+
384
+ **Column 2 (Middle) - Request Body Editor:**
385
+ - Glassmorphism design with backdrop blur
386
+ - Auto-filled mock data examples
387
+ - JSON editor with syntax highlighting
388
+ - Copy-to-clipboard functionality
389
+ - Real-time validation
390
+
391
+ **Column 3 (Right) - Test Request Panel:**
392
+ - Enhanced glassmorphism with cyan border glow
393
+ - Large "Send Request" button with gradient animation
394
+ - Terminal-style response viewer (black background, green text)
395
+ - Status code indicators
396
+ - Response headers display
362
397
 
363
398
  ### ๐ŸŽจ Theme Customization
364
399
 
365
400
  **Futuristic Theme (Default):**
366
401
  ```typescript
367
402
  NestScrambleModule.forRoot({
368
- theme: 'futuristic', // Modern, dark, glassmorphic
403
+ theme: 'futuristic', // Professional dark dashboard
369
404
  primaryColor: '#00f2ff', // Cyber-Cyan (default)
370
405
  customDomainIcon: '/logo.png', // Your brand favicon
371
406
  apiTitle: 'My Awesome API',
@@ -406,14 +441,16 @@ NestScrambleModule.forRoot({
406
441
 
407
442
  When you visit `http://localhost:3000/docs`, you'll experience:
408
443
 
409
- - ๐ŸŽฏ **Interactive API Explorer** - Test endpoints directly from the browser
410
- - ๐Ÿ“ **Auto-generated Examples** - Request/response samples for all endpoints
411
- - ๐Ÿ” **Spotlight Search** - Quickly find endpoints with glowing focus states
412
- - ๐ŸŒ™ **Futuristic Dark Mode** - Deep space theme with glassmorphism
413
- - ๐Ÿ“ฑ **Mobile Responsive** - Works beautifully on all devices
414
- - ๐ŸŽจ **Theme Toggle** - Switch between Futuristic and Classic (top-right button)
415
- - โœจ **Powered by Badge** - Glowing brand badge with pulse animation
416
- - ๐ŸŽญ **Easter Eggs** - Check your browser console for surprises!
444
+ - ๐ŸŽฏ **Single-Request Navigation** - Each endpoint on its own dedicated page
445
+ - ๐Ÿ“‚ **Controller Grouping** - Organized sidebar with uppercase section headers
446
+ - ๐ŸŽจ **Active State Glow** - Cyber-cyan highlight for selected endpoints
447
+ - ๐Ÿ“ **Auto-generated Examples** - Pre-filled mock data in request editor
448
+ - ๐Ÿงช **Live Testing** - Send requests directly from the three-column interface
449
+ - ๐Ÿ’ป **Terminal Response** - Black box with green text for authentic feel
450
+ - ๐Ÿ” **Quick Search** - Press 'K' to search endpoints instantly
451
+ - ๐Ÿ“ฑ **Responsive Design** - Adapts to mobile, tablet, and desktop
452
+ - โœจ **Animated Branding** - Pulsing "Powered by Nest-Scramble" badge
453
+ - ๐ŸŽญ **Developer Easter Eggs** - Check your browser console for surprises!
417
454
 
418
455
  ### ๐Ÿ–ฅ๏ธ Terminal Dashboard
419
456
 
@@ -6,9 +6,7 @@ export declare class DocsController {
6
6
  private options;
7
7
  constructor(openApiSpec: any, options: NestScrambleOptions);
8
8
  getDocs(res: any): void;
9
- private getFuturisticCSS;
10
- private getClassicCSS;
11
- private getEasterEggScript;
9
+ private getProfessionalCSS;
12
10
  getOpenApiJson(res: any): void;
13
11
  getOpenApiJsonLegacy(res: any): void;
14
12
  getOpenApiSpec(): any;
@@ -1 +1 @@
1
- {"version":3,"file":"DocsController.d.ts","sourceRoot":"","sources":["../../src/controllers/DocsController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,MAAM,wDAAyC,CAAC;AAE7D,qBAEa,cAAc;IAEU,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,OAAO;gBADP,WAAW,EAAE,GAAG,EAChB,OAAO,EAAE,mBAAmB;IAIvE,OAAO,CAAQ,GAAG,EAAE,GAAG;IAqEvB,OAAO,CAAC,gBAAgB;IAy3BxB,OAAO,CAAC,aAAa;IA8CrB,OAAO,CAAC,kBAAkB;IAsB1B,cAAc,CAAQ,GAAG,EAAE,GAAG;IAa9B,oBAAoB,CAAQ,GAAG,EAAE,GAAG;IAKpC,cAAc;CAGf"}
1
+ {"version":3,"file":"DocsController.d.ts","sourceRoot":"","sources":["../../src/controllers/DocsController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,MAAM,wDAAyC,CAAC;AAE7D,qBAEa,cAAc;IAEU,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,OAAO;gBADP,WAAW,EAAE,GAAG,EAChB,OAAO,EAAE,mBAAmB;IAIvE,OAAO,CAAQ,GAAG,EAAE,GAAG;IA+DvB,OAAO,CAAC,kBAAkB;IAsQ1B,cAAc,CAAQ,GAAG,EAAE,GAAG;IAa9B,oBAAoB,CAAQ,GAAG,EAAE,GAAG;IAKpC,cAAc;CAGf"}