wynkjs 1.0.7 → 1.0.9

package/README.md

@@ -573,6 +573,82 @@ export function myPlugin(options = {}) {
 app.use(myPlugin({ option: "value" }));
 ```
 
+#### Swagger / OpenAPI Documentation
+
+**✨ New Feature**: WynkJS can use Elysia's Swagger plugin for automatic API documentation!
+
+Since WynkJS is built on top of Elysia, you can use the official `@elysiajs/swagger` plugin to generate interactive API documentation from your WynkJS decorators.
+
+```bash
+bun add @elysiajs/swagger
+```
+
+```typescript
+import { WynkFactory } from "wynkjs";
+import { swagger } from "@elysiajs/swagger";
+
+const app = WynkFactory.create({
+  controllers: [UserController, ProductController],
+});
+
+const server = await app.build();
+
+// Add Swagger documentation
+server.use(
+  swagger({
+    documentation: {
+      info: {
+        title: "My API Documentation",
+        version: "1.0.0",
+        description: "Auto-generated from WynkJS decorators",
+      },
+      tags: [
+        { name: "users", description: "User management" },
+        { name: "products", description: "Product catalog" },
+      ],
+    },
+    path: "/docs",
+  })
+);
+
+server.listen(3000);
+// 📚 Visit: http://localhost:3000/docs
+```
+
+**What gets auto-documented:**
+
+✅ All HTTP routes (@Get, @Post, etc.)  
+✅ Query parameters (from DTOs)  
+✅ Request body schemas (from DTOs)  
+✅ Path parameters (from DTOs)  
+✅ Validation rules (min, max, format)  
+✅ JWT Authentication support
+
+**With JWT Authentication:**
+
+```typescript
+server.use(
+  swagger({
+    documentation: {
+      info: { title: "Secure API", version: "1.0.0" },
+      components: {
+        securitySchemes: {
+          bearerAuth: {
+            type: "http",
+            scheme: "bearer",
+            bearerFormat: "JWT",
+          },
+        },
+      },
+      security: [{ bearerAuth: [] }],
+    },
+    path: "/docs",
+  })
+);
+```
+
+📚 See [Swagger Integration Guide](./docs/SWAGGER_INTEGRATION.md) for complete examples and best practices.
+
 ### �🔒 Authentication with Guards
 
 ```typescript

package/dist/common/http-status.enum.d.ts

@@ -0,0 +1,129 @@
+/**
+ * HTTP Status Codes enum for WynkJS Framework.
+ *
+ * Provides named constants for all standard HTTP status codes (RFC 7231 and beyond),
+ * matching NestJS's HttpStatus enum for API compatibility.
+ *
+ * @example
+ * import { HttpStatus } from 'wynkjs';
+ *
+ * @Get('/')
+ * @HttpCode(HttpStatus.OK)
+ * findAll() { return []; }
+ *
+ * throw new HttpException('Not found', HttpStatus.NOT_FOUND);
+ *
+ * @since 1.0.0
+ */
+export declare enum HttpStatus {
+    /** 100 Continue */
+    CONTINUE = 100,
+    /** 101 Switching Protocols */
+    SWITCHING_PROTOCOLS = 101,
+    /** 102 Processing */
+    PROCESSING = 102,
+    /** 103 Early Hints */
+    EARLYHINTS = 103,
+    /** 200 OK */
+    OK = 200,
+    /** 201 Created */
+    CREATED = 201,
+    /** 202 Accepted */
+    ACCEPTED = 202,
+    /** 203 Non-Authoritative Information */
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    /** 204 No Content */
+    NO_CONTENT = 204,
+    /** 205 Reset Content */
+    RESET_CONTENT = 205,
+    /** 206 Partial Content */
+    PARTIAL_CONTENT = 206,
+    /** 207 Multi-Status */
+    MULTI_STATUS = 207,
+    /** 208 Already Reported */
+    ALREADY_REPORTED = 208,
+    /** 210 Content Different */
+    CONTENT_DIFFERENT = 210,
+    /** 300 Multiple Choices */
+    AMBIGUOUS = 300,
+    /** 301 Moved Permanently */
+    MOVED_PERMANENTLY = 301,
+    /** 302 Found */
+    FOUND = 302,
+    /** 303 See Other */
+    SEE_OTHER = 303,
+    /** 304 Not Modified */
+    NOT_MODIFIED = 304,
+    /** 307 Temporary Redirect */
+    TEMPORARY_REDIRECT = 307,
+    /** 308 Permanent Redirect */
+    PERMANENT_REDIRECT = 308,
+    /** 400 Bad Request */
+    BAD_REQUEST = 400,
+    /** 401 Unauthorized */
+    UNAUTHORIZED = 401,
+    /** 402 Payment Required */
+    PAYMENT_REQUIRED = 402,
+    /** 403 Forbidden */
+    FORBIDDEN = 403,
+    /** 404 Not Found */
+    NOT_FOUND = 404,
+    /** 405 Method Not Allowed */
+    METHOD_NOT_ALLOWED = 405,
+    /** 406 Not Acceptable */
+    NOT_ACCEPTABLE = 406,
+    /** 407 Proxy Authentication Required */
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    /** 408 Request Timeout */
+    REQUEST_TIMEOUT = 408,
+    /** 409 Conflict */
+    CONFLICT = 409,
+    /** 410 Gone */
+    GONE = 410,
+    /** 411 Length Required */
+    LENGTH_REQUIRED = 411,
+    /** 412 Precondition Failed */
+    PRECONDITION_FAILED = 412,
+    /** 413 Payload Too Large */
+    PAYLOAD_TOO_LARGE = 413,
+    /** 414 URI Too Long */
+    URI_TOO_LONG = 414,
+    /** 415 Unsupported Media Type */
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    /** 416 Range Not Satisfiable */
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+    /** 417 Expectation Failed */
+    EXPECTATION_FAILED = 417,
+    /** 418 I'm a Teapot */
+    I_AM_A_TEAPOT = 418,
+    /** 421 Misdirected Request */
+    MISDIRECTED = 421,
+    /** 422 Unprocessable Entity */
+    UNPROCESSABLE_ENTITY = 422,
+    /** 423 Locked */
+    LOCKED = 423,
+    /** 424 Failed Dependency */
+    FAILED_DEPENDENCY = 424,
+    /** 428 Precondition Required */
+    PRECONDITION_REQUIRED = 428,
+    /** 429 Too Many Requests */
+    TOO_MANY_REQUESTS = 429,
+    /** 456 Unrecoverable Error */
+    UNRECOVERABLE_ERROR = 456,
+    /** 500 Internal Server Error */
+    INTERNAL_SERVER_ERROR = 500,
+    /** 501 Not Implemented */
+    NOT_IMPLEMENTED = 501,
+    /** 502 Bad Gateway */
+    BAD_GATEWAY = 502,
+    /** 503 Service Unavailable */
+    SERVICE_UNAVAILABLE = 503,
+    /** 504 Gateway Timeout */
+    GATEWAY_TIMEOUT = 504,
+    /** 505 HTTP Version Not Supported */
+    HTTP_VERSION_NOT_SUPPORTED = 505,
+    /** 507 Insufficient Storage */
+    INSUFFICIENT_STORAGE = 507,
+    /** 508 Loop Detected */
+    LOOP_DETECTED = 508
+}

package/dist/common/http-status.enum.js

@@ -0,0 +1,135 @@
+/**
+ * HTTP Status Codes enum for WynkJS Framework.
+ *
+ * Provides named constants for all standard HTTP status codes (RFC 7231 and beyond),
+ * matching NestJS's HttpStatus enum for API compatibility.
+ *
+ * @example
+ * import { HttpStatus } from 'wynkjs';
+ *
+ * @Get('/')
+ * @HttpCode(HttpStatus.OK)
+ * findAll() { return []; }
+ *
+ * throw new HttpException('Not found', HttpStatus.NOT_FOUND);
+ *
+ * @since 1.0.0
+ */
+export var HttpStatus;
+(function (HttpStatus) {
+    // 1xx Informational
+    /** 100 Continue */
+    HttpStatus[HttpStatus["CONTINUE"] = 100] = "CONTINUE";
+    /** 101 Switching Protocols */
+    HttpStatus[HttpStatus["SWITCHING_PROTOCOLS"] = 101] = "SWITCHING_PROTOCOLS";
+    /** 102 Processing */
+    HttpStatus[HttpStatus["PROCESSING"] = 102] = "PROCESSING";
+    /** 103 Early Hints */
+    HttpStatus[HttpStatus["EARLYHINTS"] = 103] = "EARLYHINTS";
+    // 2xx Success
+    /** 200 OK */
+    HttpStatus[HttpStatus["OK"] = 200] = "OK";
+    /** 201 Created */
+    HttpStatus[HttpStatus["CREATED"] = 201] = "CREATED";
+    /** 202 Accepted */
+    HttpStatus[HttpStatus["ACCEPTED"] = 202] = "ACCEPTED";
+    /** 203 Non-Authoritative Information */
+    HttpStatus[HttpStatus["NON_AUTHORITATIVE_INFORMATION"] = 203] = "NON_AUTHORITATIVE_INFORMATION";
+    /** 204 No Content */
+    HttpStatus[HttpStatus["NO_CONTENT"] = 204] = "NO_CONTENT";
+    /** 205 Reset Content */
+    HttpStatus[HttpStatus["RESET_CONTENT"] = 205] = "RESET_CONTENT";
+    /** 206 Partial Content */
+    HttpStatus[HttpStatus["PARTIAL_CONTENT"] = 206] = "PARTIAL_CONTENT";
+    /** 207 Multi-Status */
+    HttpStatus[HttpStatus["MULTI_STATUS"] = 207] = "MULTI_STATUS";
+    /** 208 Already Reported */
+    HttpStatus[HttpStatus["ALREADY_REPORTED"] = 208] = "ALREADY_REPORTED";
+    /** 210 Content Different */
+    HttpStatus[HttpStatus["CONTENT_DIFFERENT"] = 210] = "CONTENT_DIFFERENT";
+    // 3xx Redirection
+    /** 300 Multiple Choices */
+    HttpStatus[HttpStatus["AMBIGUOUS"] = 300] = "AMBIGUOUS";
+    /** 301 Moved Permanently */
+    HttpStatus[HttpStatus["MOVED_PERMANENTLY"] = 301] = "MOVED_PERMANENTLY";
+    /** 302 Found */
+    HttpStatus[HttpStatus["FOUND"] = 302] = "FOUND";
+    /** 303 See Other */
+    HttpStatus[HttpStatus["SEE_OTHER"] = 303] = "SEE_OTHER";
+    /** 304 Not Modified */
+    HttpStatus[HttpStatus["NOT_MODIFIED"] = 304] = "NOT_MODIFIED";
+    /** 307 Temporary Redirect */
+    HttpStatus[HttpStatus["TEMPORARY_REDIRECT"] = 307] = "TEMPORARY_REDIRECT";
+    /** 308 Permanent Redirect */
+    HttpStatus[HttpStatus["PERMANENT_REDIRECT"] = 308] = "PERMANENT_REDIRECT";
+    // 4xx Client Errors
+    /** 400 Bad Request */
+    HttpStatus[HttpStatus["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    /** 401 Unauthorized */
+    HttpStatus[HttpStatus["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    /** 402 Payment Required */
+    HttpStatus[HttpStatus["PAYMENT_REQUIRED"] = 402] = "PAYMENT_REQUIRED";
+    /** 403 Forbidden */
+    HttpStatus[HttpStatus["FORBIDDEN"] = 403] = "FORBIDDEN";
+    /** 404 Not Found */
+    HttpStatus[HttpStatus["NOT_FOUND"] = 404] = "NOT_FOUND";
+    /** 405 Method Not Allowed */
+    HttpStatus[HttpStatus["METHOD_NOT_ALLOWED"] = 405] = "METHOD_NOT_ALLOWED";
+    /** 406 Not Acceptable */
+    HttpStatus[HttpStatus["NOT_ACCEPTABLE"] = 406] = "NOT_ACCEPTABLE";
+    /** 407 Proxy Authentication Required */
+    HttpStatus[HttpStatus["PROXY_AUTHENTICATION_REQUIRED"] = 407] = "PROXY_AUTHENTICATION_REQUIRED";
+    /** 408 Request Timeout */
+    HttpStatus[HttpStatus["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
+    /** 409 Conflict */
+    HttpStatus[HttpStatus["CONFLICT"] = 409] = "CONFLICT";
+    /** 410 Gone */
+    HttpStatus[HttpStatus["GONE"] = 410] = "GONE";
+    /** 411 Length Required */
+    HttpStatus[HttpStatus["LENGTH_REQUIRED"] = 411] = "LENGTH_REQUIRED";
+    /** 412 Precondition Failed */
+    HttpStatus[HttpStatus["PRECONDITION_FAILED"] = 412] = "PRECONDITION_FAILED";
+    /** 413 Payload Too Large */
+    HttpStatus[HttpStatus["PAYLOAD_TOO_LARGE"] = 413] = "PAYLOAD_TOO_LARGE";
+    /** 414 URI Too Long */
+    HttpStatus[HttpStatus["URI_TOO_LONG"] = 414] = "URI_TOO_LONG";
+    /** 415 Unsupported Media Type */
+    HttpStatus[HttpStatus["UNSUPPORTED_MEDIA_TYPE"] = 415] = "UNSUPPORTED_MEDIA_TYPE";
+    /** 416 Range Not Satisfiable */
+    HttpStatus[HttpStatus["REQUESTED_RANGE_NOT_SATISFIABLE"] = 416] = "REQUESTED_RANGE_NOT_SATISFIABLE";
+    /** 417 Expectation Failed */
+    HttpStatus[HttpStatus["EXPECTATION_FAILED"] = 417] = "EXPECTATION_FAILED";
+    /** 418 I'm a Teapot */
+    HttpStatus[HttpStatus["I_AM_A_TEAPOT"] = 418] = "I_AM_A_TEAPOT";
+    /** 421 Misdirected Request */
+    HttpStatus[HttpStatus["MISDIRECTED"] = 421] = "MISDIRECTED";
+    /** 422 Unprocessable Entity */
+    HttpStatus[HttpStatus["UNPROCESSABLE_ENTITY"] = 422] = "UNPROCESSABLE_ENTITY";
+    /** 423 Locked */
+    HttpStatus[HttpStatus["LOCKED"] = 423] = "LOCKED";
+    /** 424 Failed Dependency */
+    HttpStatus[HttpStatus["FAILED_DEPENDENCY"] = 424] = "FAILED_DEPENDENCY";
+    /** 428 Precondition Required */
+    HttpStatus[HttpStatus["PRECONDITION_REQUIRED"] = 428] = "PRECONDITION_REQUIRED";
+    /** 429 Too Many Requests */
+    HttpStatus[HttpStatus["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
+    /** 456 Unrecoverable Error */
+    HttpStatus[HttpStatus["UNRECOVERABLE_ERROR"] = 456] = "UNRECOVERABLE_ERROR";
+    // 5xx Server Errors
+    /** 500 Internal Server Error */
+    HttpStatus[HttpStatus["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+    /** 501 Not Implemented */
+    HttpStatus[HttpStatus["NOT_IMPLEMENTED"] = 501] = "NOT_IMPLEMENTED";
+    /** 502 Bad Gateway */
+    HttpStatus[HttpStatus["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
+    /** 503 Service Unavailable */
+    HttpStatus[HttpStatus["SERVICE_UNAVAILABLE"] = 503] = "SERVICE_UNAVAILABLE";
+    /** 504 Gateway Timeout */
+    HttpStatus[HttpStatus["GATEWAY_TIMEOUT"] = 504] = "GATEWAY_TIMEOUT";
+    /** 505 HTTP Version Not Supported */
+    HttpStatus[HttpStatus["HTTP_VERSION_NOT_SUPPORTED"] = 505] = "HTTP_VERSION_NOT_SUPPORTED";
+    /** 507 Insufficient Storage */
+    HttpStatus[HttpStatus["INSUFFICIENT_STORAGE"] = 507] = "INSUFFICIENT_STORAGE";
+    /** 508 Loop Detected */
+    HttpStatus[HttpStatus["LOOP_DETECTED"] = 508] = "LOOP_DETECTED";
+})(HttpStatus || (HttpStatus = {}));

package/dist/cors.d.ts

@@ -25,4 +25,3 @@ export declare function setupCors(app: Elysia, corsOptions: boolean | CorsOption
  * @returns true if valid, throws error if invalid
  */
 export declare function validateCorsOptions(corsOptions: boolean | CorsOptions): boolean;
-//# sourceMappingURL=cors.d.ts.map

package/dist/cors.js

@@ -6,7 +6,7 @@
  */
 export function setupCors(app, corsOptions) {
     try {
-        // Try to import @elysiajs/cors
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
         const { cors } = require("@elysiajs/cors");
         if (corsOptions === true) {
             // Simple CORS - allow all origins
@@ -63,7 +63,7 @@ export function setupCors(app, corsOptions) {
             console.log("✅ CORS enabled with custom configuration");
         }
     }
-    catch (error) {
+    catch (_error) {
         console.error("❌ Failed to enable CORS: @elysiajs/cors package not found");
         console.error("   Install it with: bun add @elysiajs/cors");
         console.error("   Or remove cors option from ApplicationOptions to skip CORS setup");

package/dist/database.d.ts

@@ -33,4 +33,3 @@ export declare const MONGOOSE_EXAMPLE = "\n// With Mongoose (COPY TO YOUR PROJEC
  * That's it! WynkJS doesn't force you to use any specific pattern.
  * We give you the freedom to choose what works best for your project.
  */
-//# sourceMappingURL=database.d.ts.map

package/dist/decorators/database.decorators.d.ts

@@ -52,4 +52,3 @@ export declare function registerTables(tables: Record<string, any>): void;
  */
 export declare function registerModels(models: Record<string, any>): void;
 export { injectable, inject, singleton, container } from "tsyringe";
-//# sourceMappingURL=database.decorators.d.ts.map

package/dist/decorators/database.decorators.js

@@ -99,7 +99,7 @@ export function InjectModel(model) {
  * ```
  */
 export function registerTables(tables) {
-    for (const [name, table] of Object.entries(tables)) {
+    for (const [_name, table] of Object.entries(tables)) {
         const token = getOrCreateTableToken(table);
         if (!container.isRegistered(token)) {
             container.register(token, { useValue: table });
@@ -120,7 +120,7 @@ export function registerTables(tables) {
  * ```
  */
 export function registerModels(models) {
-    for (const [name, model] of Object.entries(models)) {
+    for (const [_name, model] of Object.entries(models)) {
         const token = getOrCreateModelToken(model);
         if (!container.isRegistered(token)) {
             container.register(token, { useValue: model });

package/dist/decorators/di.decorators.d.ts

@@ -0,0 +1,13 @@
+import "reflect-metadata";
+/**
+ * Marks a constructor parameter or class property as optional.
+ * When the dependency cannot be resolved, `undefined` is injected instead of
+ * throwing an error.
+ *
+ * @example
+ * @Injectable()
+ * class MyService {
+ *   constructor(@Optional() private logger?: LoggerService) {}
+ * }
+ */
+export declare function Optional(): PropertyDecorator & ParameterDecorator;

package/dist/decorators/di.decorators.js

@@ -0,0 +1,28 @@
+import "reflect-metadata";
+/**
+ * Marks a constructor parameter or class property as optional.
+ * When the dependency cannot be resolved, `undefined` is injected instead of
+ * throwing an error.
+ *
+ * @example
+ * @Injectable()
+ * class MyService {
+ *   constructor(@Optional() private logger?: LoggerService) {}
+ * }
+ */
+export function Optional() {
+    return (target, propertyKey, parameterIndex) => {
+        if (typeof parameterIndex === "number") {
+            const existingOptionals = [
+                ...(Reflect.getOwnMetadata("optional:params", target, propertyKey) ?? []),
+            ];
+            if (!existingOptionals.includes(parameterIndex)) {
+                existingOptionals.push(parameterIndex);
+            }
+            Reflect.defineMetadata("optional:params", existingOptionals, target, propertyKey);
+        }
+        else if (propertyKey !== undefined) {
+            Reflect.defineMetadata("optional", true, target, propertyKey);
+        }
+    };
+}

package/dist/decorators/exception.decorators.d.ts

@@ -37,6 +37,21 @@ export declare function UseFilters(...filters: (Function | WynkExceptionFilter)[
 /**
  * Built-in HTTP Exceptions
  */
+/**
+ * Base HTTP exception class. All WynkJS HTTP exceptions extend this.
+ *
+ * Throw any `HttpException` subclass from a controller method — WynkJS will
+ * convert it into the appropriate HTTP response automatically.
+ *
+ * @param message - Human-readable error description sent in the response body.
+ * @param statusCode - HTTP status code (e.g. `404`, `500`).
+ * @param error - Short error category string (e.g. `'Not Found'`). Optional.
+ *
+ * @example
+ * ```typescript
+ * throw new HttpException('Custom error', 418);
+ * ```
+ */
 export declare class HttpException extends Error {
     readonly message: string;
     readonly statusCode: number;
@@ -46,42 +61,55 @@ export declare class HttpException extends Error {
     getStatus(): number;
     getResponse(): any;
 }
+/** Thrown when the request is malformed or contains invalid data (HTTP 400). */
 export declare class BadRequestException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the request lacks valid authentication credentials (HTTP 401). */
 export declare class UnauthorizedException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the authenticated user does not have permission (HTTP 403). */
 export declare class ForbiddenException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the requested resource does not exist (HTTP 404). */
 export declare class NotFoundException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the HTTP method is not supported for the endpoint (HTTP 405). */
 export declare class MethodNotAllowedException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the server cannot produce a response matching the `Accept` header (HTTP 406). */
 export declare class NotAcceptableException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the server did not receive a timely response (HTTP 408). */
 export declare class RequestTimeoutException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the request conflicts with the current state of the resource (HTTP 409). */
 export declare class ConflictException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when a resource already exists and cannot be created again (HTTP 409). */
 export declare class AlreadyExistsException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the requested resource is no longer available (HTTP 410). */
 export declare class GoneException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the request body exceeds the server's size limit (HTTP 413). */
 export declare class PayloadTooLargeException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the request's `Content-Type` is not supported (HTTP 415). */
 export declare class UnsupportedMediaTypeException extends HttpException {
     constructor(message?: string);
 }
+/** Thrown when the request is well-formed but cannot be processed (HTTP 422). */
 export declare class UnprocessableEntityException extends HttpException {
     constructor(message?: string);
 }
@@ -100,6 +128,12 @@ export declare class ServiceUnavailableException extends HttpException {
 export declare class GatewayTimeoutException extends HttpException {
     constructor(message?: string);
 }
+export declare class TooManyRequestsException extends HttpException {
+    constructor(message?: string);
+}
+export declare class HttpVersionNotSupportedException extends HttpException {
+    constructor(message?: string);
+}
 /**
  * Helper function to execute exception filters
  */
@@ -209,4 +243,3 @@ export declare class BusinessLogicException implements WynkExceptionFilter {
         details: any;
     };
 }
-//# sourceMappingURL=exception.decorators.d.ts.map