@mini2/core 1.1.0 → 1.1.1

package/Readme.MD

@@ -756,15 +756,84 @@ const result = sum(5, 3); // 8
 
 ### 📖 Swagger Integration
 
-Automatic API documentation is generated based on your decorators and DTOs.
+@mini2/core automatically generates comprehensive API documentation using Swagger/OpenAPI 3.0 specification based on your decorators and DTOs.
+
+#### **📍 API Documentation Endpoints**
+
+When your application starts, Swagger documentation is automatically available at:
+
+```typescript
+// Interactive Swagger UI - Test your API directly in browser
+http://localhost:3000/api-docs
+
+// Raw OpenAPI JSON specification - For tools, imports, etc.
+http://localhost:3000/api-docs.json
+```
+
+#### **🔧 Automatic Documentation Features**
+
+- **Route Discovery**: All `@controller` and HTTP method decorators are automatically documented
+- **Request/Response Schemas**: DTO classes with `class-validator` decorators generate JSON schemas
+- **Security Requirements**: `@authenticated` and `@authorized` decorators add security info
+- **Parameter Documentation**: Path parameters, query parameters, and request bodies are documented
+- **HTTP Status Codes**: Response codes from `ResponseBuilder` and exceptions are included
+
+#### **📋 Example Generated Documentation**
+
+For this controller:
+
+```typescript
+@controller('/api/users')
+export class UserController {
+	@get('/:id')
+	@authenticated()
+	@authorized(['user:read'])
+	@validate({ params: UserParamsDto })
+	async getUser(@req() req: Request) {
+		const id = req.params.id;
+		const user = await this.userService.findById(id);
+		return new ResponseBuilder().ok(user);
+	}
+
+	@post('/')
+	@validate({ body: CreateUserDto })
+	async createUser(@req() req: Request) {
+		const userData = req.body;
+		const user = await this.userService.create(userData);
+		return new ResponseBuilder().created(user);
+	}
+}
+```
+
+Swagger will automatically generate:
+
+- **GET /api/users/{id}** - Requires authentication and authorization
+- **POST /api/users** - With CreateUserDto schema for request body
+- Parameter definitions, security requirements, and response schemas
+
+#### **🎯 DTO-Based Schema Generation**
+
+Class-validator decorators automatically create OpenAPI schemas:
 
 ```typescript
-// Swagger documentation available at:
-// http://localhost:3000/api-docs      - Swagger UI
-// http://localhost:3000/api-docs.json - OpenAPI JSON spec
+export class CreateUserDto {
+	@IsEmail()
+	email: string;
+
+	@IsString()
+	@MinLength(2)
+	name: string;
+
+	@IsOptional()
+	@IsNumber()
+	@Min(0)
+	age?: number;
+}
 ```
 
-**Swagger Configuration:**
+#### **⚙️ Swagger Configuration**
+
+Default configuration is applied automatically, but you can customize it:
 
 ```typescript
 const swaggerOptions = {
@@ -772,11 +841,63 @@ const swaggerOptions = {
 	description: `API documentation for ${config.applicationName}`,
 	version: '1.0.0',
 	servers: [{ url: `http://${config.host}:${config.port}` }],
-	docsPath: '/api-docs',
-	jsonPath: '/api-docs.json',
+	docsPath: '/api-docs', // Swagger UI endpoint
+	jsonPath: '/api-docs.json', // OpenAPI JSON endpoint
+	components: {
+		securitySchemes: {
+			bearerAuth: {
+				type: 'http',
+				scheme: 'bearer',
+				bearerFormat: 'JWT',
+			},
+		},
+	},
 };
 ```
 
+#### **🔐 Security Documentation**
+
+Security decorators automatically add authentication requirements:
+
+```typescript
+@get('/profile')
+@authenticated()
+@authorized(['user:profile'])
+async getProfile(@req() req: Request) {
+  // Swagger will show:
+  // - 🔒 Authentication required
+  // - 🛡️ Requires 'user:profile' permission
+  // - 401 Unauthorized response possible
+  // - 403 Forbidden response possible
+}
+```
+
+#### **📊 Response Documentation**
+
+ResponseBuilder methods automatically document response types:
+
+```typescript
+@post('/users')
+async createUser(@req() req: Request) {
+  const user = await this.userService.create(req.body);
+
+  // Swagger documents:
+  // - 201 Created status
+  // - User object schema in response body
+  // - Location header if set
+  return new ResponseBuilder()
+    .created(user)
+    .setHeader('Location', `/users/${user.id}`);
+}
+```
+
+#### **🚀 Production Usage**
+
+- Swagger UI is automatically available in all environments
+- For production, consider disabling Swagger UI and keeping only JSON endpoint
+- OpenAPI JSON can be used with external documentation tools
+- All validation errors are automatically documented with examples
+
 ### 📝 TypeScript Support
 
 Full TypeScript support with type-safe API development:

package/dist/interfaces/repository.interface.d.ts

@@ -1,14 +1,9 @@
-export interface TimestampFields {
-    id: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
 export interface IRepository<IdentifierType, ModelType> {
-    findAll(): Promise<(ModelType & TimestampFields)[]>;
-    findById(id: IdentifierType): Promise<(ModelType & TimestampFields) | null>;
-    create(item: ModelType): Promise<ModelType & TimestampFields>;
-    update(id: IdentifierType, item: Partial<ModelType>): Promise<ModelType & TimestampFields>;
+    findAll(): Promise<ModelType[]>;
+    findById(id: IdentifierType): Promise<ModelType | null>;
+    create(item: ModelType): Promise<ModelType>;
+    update(id: IdentifierType, item: Partial<ModelType>): Promise<ModelType>;
     delete(id: IdentifierType): Promise<void>;
-    findPaginated(query: Partial<ModelType>, page: number, limit: number): Promise<(ModelType & TimestampFields)[]>;
+    findPaginated(query: Partial<ModelType>, page: number, limit: number): Promise<ModelType[]>;
 }
 //# sourceMappingURL=repository.interface.d.ts.map

package/dist/interfaces/repository.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repository.interface.d.ts","sourceRoot":"","sources":["../../interfaces/repository.interface.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CAChB;AAGD,MAAM,WAAW,WAAW,CAAC,cAAc,EAAE,SAAS;IACrD,OAAO,IAAI,OAAO,CAAC,CAAC,SAAS,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;IACpD,QAAQ,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,SAAS,GAAG,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5E,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,GAAG,eAAe,CAAC,CAAC;IAC9D,MAAM,CACL,EAAE,EAAE,cAAc,EAClB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GACtB,OAAO,CAAC,SAAS,GAAG,eAAe,CAAC,CAAC;IACxC,MAAM,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,aAAa,CACZ,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,EACzB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,SAAS,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;CAC5C"}
+{"version":3,"file":"repository.interface.d.ts","sourceRoot":"","sources":["../../interfaces/repository.interface.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,WAAW,CAAC,cAAc,EAAE,SAAS;IACrD,OAAO,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IACxD,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACzE,MAAM,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,aAAa,CACZ,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,EACzB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACX,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;CACxB"}

package/package.json

@@ -25,7 +25,7 @@
 	"license": "ISC",
 	"description": "Mini Express Framework - Lightweight and modular Express.js framework with TypeScript support",
 	"name": "@mini2/core",
-	"version": "1.1.0",
+	"version": "1.1.1",
 	"author": "Mustafa Çolakoglu <mustafacolakoglu94@gmail.com> (https://github.com/mustafa-colakoglu)",
 	"dependencies": {
 		"class-transformer": "^0.5.1",