wynkjs 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alam Jamal
+
+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

@@ -0,0 +1,522 @@
+# 🚀 WynkJS
+
+<div align="center">
+
+**A high-performance TypeScript framework built on Elysia with NestJS-style decorators**
+
+[![npm version](https://img.shields.io/npm/v/wynkjs.svg)](https://www.npmjs.com/package/wynkjs)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
+
+_20x faster than Express, easier than NestJS_ ⚡
+
+[Documentation](#documentation) • [Quick Start](#quick-start) • [Examples](#examples) • [Features](#features)
+
+</div>
+
+---
+
+## About
+
+WynkJS is a modern, TypeScript-first web framework that brings NestJS-style decorators to the blazing-fast Elysia runtime. It’s a lightweight NestJS alternative with familiar concepts—controllers, dependency injection, guards, pipes, interceptors, and exception filters—designed for building high‑performance REST APIs and backends on Node.js or Bun. WynkJS embraces ESM, ships first-class types, and keeps things simple so you can move fast without the bloat.
+
+Keywords: NestJS alternative, Elysia framework, TypeScript decorators, dependency injection (DI), guards, pipes, interceptors, exception filters, fast web framework, REST API, backend, Bun, Node.js.
+
+---
+
+## ✨ Why WynkJS?
+
+WynkJS combines the **speed of Elysia** with the **elegant decorator syntax of NestJS**, giving you the best of both worlds:
+
+- 🚀 **20x Faster** - Built on Elysia, one of the fastest web frameworks
+- 🎨 **Decorator-Based** - Familiar NestJS-style decorators
+- 💉 **Dependency Injection** - Built-in DI with tsyringe
+- 🔒 **Type-Safe** - Full TypeScript support
+- 🎯 **Simple & Clean** - Easy to learn, powerful to use
+- 🔌 **Middleware Support** - Guards, interceptors, pipes, filters
+- ⚡ **Hot Reload** - Fast development with Bun
+
+---
+
+## 📦 Installation
+
+```bash
+npm install wynkjs elysia reflect-metadata
+```
+
+Or with Bun:
+
+```bash
+bun add wynkjs elysia reflect-metadata
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Create Your First Controller
+
+```typescript
+import { Controller, Get, Post, Body } from "wynkjs";
+import { injectable } from "tsyringe";
+
+@injectable()
+@Controller("/users")
+export class UserController {
+  @Get("/")
+  async list() {
+    return { users: ["Alice", "Bob", "Charlie"] };
+  }
+
+  @Post("/")
+  async create(@Body() body: any) {
+    return { message: "User created", data: body };
+  }
+
+  @Get("/:id")
+  async findOne(@Param("id") id: string) {
+    return { user: { id, name: "Alice" } };
+  }
+}
+```
+
+### 2. Create Your Application
+
+```typescript
+import "reflect-metadata";
+import { WynkFramework } from "wynkjs";
+import { UserController } from "./controllers/user.controller";
+
+const app = await WynkFramework.create({
+  controllers: [UserController],
+});
+
+await app.listen(3000);
+
+console.log("🚀 Server running on http://localhost:3000");
+```
+
+### 3. Run Your Server
+
+```bash
+bun run index.ts
+```
+
+That's it! 🎉
+
+---
+
+## 📚 Core Decorators
+
+### HTTP Methods
+
+```typescript
+@Get(path?: string)        // GET request
+@Post(path?: string)       // POST request
+@Put(path?: string)        // PUT request
+@Patch(path?: string)      // PATCH request
+@Delete(path?: string)     // DELETE request
+@Options(path?: string)    // OPTIONS request
+@Head(path?: string)       // HEAD request
+```
+
+### Parameter Decorators
+
+```typescript
+@Param(key?: string)       // Route parameters
+@Body()                    // Request body
+@Query(key?: string)       // Query parameters
+@Headers(key?: string)     // Request headers
+@Req()                     // Full request object
+@Res()                     // Full response object
+```
+
+### Route Options
+
+```typescript
+@HttpCode(statusCode)      // Set HTTP status code
+@Header(name, value)       // Set response header
+@Redirect(url, code?)      // Redirect response
+```
+
+### Middleware
+
+```typescript
+@Use(...middlewares)       // Apply middleware
+@UseGuards(...guards)      // Apply guards
+@UseInterceptors(...)      // Apply interceptors
+@UsePipes(...pipes)        // Apply pipes
+@UseFilters(...filters)    // Apply exception filters
+```
+
+---
+
+## 🎯 Features & Examples
+
+### 🔒 Authentication with Guards
+
+```typescript
+import { Controller, Get, Use } from "wynkjs";
+
+// Create a simple JWT guard
+const jwtGuard = async (ctx: any, next: Function) => {
+  const token = ctx.headers.authorization?.replace("Bearer ", "");
+
+  if (!token) {
+    ctx.set.status = 401;
+    return { error: "Unauthorized" };
+  }
+
+  // Verify token and attach user
+  ctx.user = await verifyToken(token);
+  return next();
+};
+
+@Controller("/protected")
+export class ProtectedController {
+  @Get("/")
+  @Use(jwtGuard)
+  async getProtectedData() {
+    return { message: "This is protected!" };
+  }
+}
+```
+
+### 🎭 Role-Based Access Control
+
+```typescript
+const rolesGuard = (allowedRoles: string[]) => {
+  return async (ctx: any, next: Function) => {
+    const userRole = ctx.user?.role;
+
+    if (!allowedRoles.includes(userRole)) {
+      ctx.set.status = 403;
+      return { error: "Forbidden" };
+    }
+
+    return next();
+  };
+};
+
+@Controller("/admin")
+@Use(jwtGuard, rolesGuard(["admin"]))
+export class AdminController {
+  @Get("/users")
+  async getAllUsers() {
+    return { users: [] };
+  }
+}
+```
+
+### 💉 Dependency Injection
+
+```typescript
+import { injectable, inject } from "tsyringe";
+
+@injectable()
+export class UserService {
+  async findAll() {
+    return [{ id: 1, name: "Alice" }];
+  }
+}
+
+@injectable()
+@Controller("/users")
+export class UserController {
+  constructor(@inject(UserService) private userService: UserService) {}
+
+  @Get("/")
+  async list() {
+    const users = await this.userService.findAll();
+    return { users };
+  }
+}
+```
+
+### 🗃️ Database Integration (Drizzle ORM)
+
+```typescript
+import { drizzle } from "drizzle-orm/node-postgres";
+import { pgTable, varchar } from "drizzle-orm/pg-core";
+import { InjectTable, registerTables } from "wynkjs";
+
+// Define your table
+const userTable = pgTable("users", {
+  id: varchar("id").primaryKey(),
+  name: varchar("name").notNull(),
+  email: varchar("email").notNull().unique(),
+});
+
+// Register tables
+registerTables({ userTable });
+
+@injectable()
+export class UserService {
+  private db = drizzle(process.env.DATABASE_URL);
+
+  constructor(@InjectTable(userTable) private table: typeof userTable) {}
+
+  async findAll() {
+    return this.db.select().from(this.table);
+  }
+}
+```
+
+### 📝 Request Validation
+
+```typescript
+import { Post, Body, UsePipes } from "wynkjs";
+import { t } from "elysia";
+
+const CreateUserDTO = t.Object({
+  name: t.String({ minLength: 2 }),
+  email: t.String({ format: "email" }),
+  password: t.String({ minLength: 8 }),
+});
+
+@Controller("/users")
+export class UserController {
+  @Post({
+    path: "/",
+    body: CreateUserDTO,
+  })
+  async create(@Body() body: any) {
+    // Body is automatically validated!
+    return { message: "User created", data: body };
+  }
+}
+```
+
+### 🔄 Multiple Middleware
+
+```typescript
+const logger = async (ctx: any, next: Function) => {
+  console.log(`${ctx.request.method} ${ctx.path}`);
+  return next();
+};
+
+const cors = async (ctx: any, next: Function) => {
+  ctx.set.headers["Access-Control-Allow-Origin"] = "*";
+  return next();
+};
+
+@Controller("/api")
+@Use(logger, cors)
+export class ApiController {
+  @Get("/data")
+  @Use(cacheMiddleware)
+  async getData() {
+    return { data: [] };
+  }
+}
+```
+
+---
+
+## 🏗️ Project Structure
+
+```
+my-wynk-app/
+├── src/
+│   ├── controllers/
+│   │   ├── user.controller.ts
+│   │   └── auth.controller.ts
+│   ├── services/
+│   │   ├── user.service.ts
+│   │   └── auth.service.ts
+│   ├── middleware/
+│   │   ├── jwt.guard.ts
+│   │   └── roles.guard.ts
+│   ├── dto/
+│   │   └── user.dto.ts
+│   └── index.ts
+├── package.json
+└── tsconfig.json
+```
+
+---
+
+## 🎨 Complete Example
+
+```typescript
+// index.ts
+import "reflect-metadata";
+import { WynkFramework } from "wynkjs";
+import { UserController } from "./controllers/user.controller";
+import { AuthController } from "./controllers/auth.controller";
+
+const app = await WynkFramework.create({
+  controllers: [UserController, AuthController],
+  globalGuards: [],
+  globalInterceptors: [],
+});
+
+await app.listen(3000);
+console.log("🚀 Server running on http://localhost:3000");
+```
+
+```typescript
+// controllers/user.controller.ts
+import { Controller, Get, Post, Put, Delete, Body, Param, Use } from "wynkjs";
+import { injectable, inject } from "tsyringe";
+import { UserService } from "../services/user.service";
+import { jwtGuard } from "../middleware/jwt.guard";
+
+@injectable()
+@Controller("/users")
+@Use(jwtGuard)
+export class UserController {
+  constructor(@inject(UserService) private userService: UserService) {}
+
+  @Get("/")
+  async list() {
+    const users = await this.userService.findAll();
+    return { users };
+  }
+
+  @Get("/:id")
+  async findOne(@Param("id") id: string) {
+    const user = await this.userService.findById(id);
+    return { user };
+  }
+
+  @Post("/")
+  async create(@Body() body: any) {
+    const user = await this.userService.create(body);
+    return { message: "User created", user };
+  }
+
+  @Put("/:id")
+  async update(@Param("id") id: string, @Body() body: any) {
+    const user = await this.userService.update(id, body);
+    return { message: "User updated", user };
+  }
+
+  @Delete("/:id")
+  @HttpCode(204)
+  async delete(@Param("id") id: string) {
+    await this.userService.delete(id);
+  }
+}
+```
+
+```typescript
+// services/user.service.ts
+import { injectable } from "tsyringe";
+
+@injectable()
+export class UserService {
+  private users = [
+    { id: "1", name: "Alice", email: "alice@example.com" },
+    { id: "2", name: "Bob", email: "bob@example.com" },
+  ];
+
+  async findAll() {
+    return this.users;
+  }
+
+  async findById(id: string) {
+    return this.users.find((u) => u.id === id);
+  }
+
+  async create(data: any) {
+    const user = { id: Date.now().toString(), ...data };
+    this.users.push(user);
+    return user;
+  }
+
+  async update(id: string, data: any) {
+    const index = this.users.findIndex((u) => u.id === id);
+    if (index !== -1) {
+      this.users[index] = { ...this.users[index], ...data };
+      return this.users[index];
+    }
+    return null;
+  }
+
+  async delete(id: string) {
+    const index = this.users.findIndex((u) => u.id === id);
+    if (index !== -1) {
+      this.users.splice(index, 1);
+    }
+  }
+}
+```
+
+---
+
+## 🔧 API Reference
+
+### WynkFramework.create(options)
+
+Create a new WynkJS application.
+
+**Options:**
+
+- `controllers: Array<Class>` - Array of controller classes
+- `globalGuards?: Array<Guard>` - Global guards (optional)
+- `globalInterceptors?: Array<Interceptor>` - Global interceptors (optional)
+- `globalPipes?: Array<Pipe>` - Global pipes (optional)
+- `globalFilters?: Array<Filter>` - Global exception filters (optional)
+
+**Returns:** Promise<WynkFramework>
+
+### app.listen(port, callback?)
+
+Start the server on the specified port.
+
+---
+
+## 🎯 Performance
+
+WynkJS is built on Elysia, which is **20x faster than Express**:
+
+| Framework  | Requests/sec | Latency (avg) |
+| ---------- | ------------ | ------------- |
+| **WynkJS** | **~250,000** | **~0.4ms**    |
+| Elysia     | ~250,000     | ~0.4ms        |
+| Fastify    | ~45,000      | ~2.2ms        |
+| Express    | ~12,000      | ~8.3ms        |
+
+_Benchmarks may vary based on hardware and configuration_
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+---
+
+## 📄 License
+
+MIT © Alam Jamal
+
+---
+
+## 🔗 Links
+
+- [GitHub Repository](https://github.com/alamjamal/wynkjs)
+- [Issue Tracker](https://github.com/alamjamal/wynkjs/issues)
+- [Elysia Documentation](https://elysiajs.com/)
+- [TypeScript Decorators](https://www.typescriptlang.org/docs/handbook/decorators.html)
+
+---
+
+## 💖 Acknowledgments
+
+Built with:
+
+- [Elysia](https://elysiajs.com/) - The fast web framework
+- [tsyringe](https://github.com/microsoft/tsyringe) - Dependency injection
+- [TypeScript](https://www.typescriptlang.org/) - Type safety
+
+---
+
+<div align="center">
+
+**[⬆ back to top](#-wynkjs)**
+
+Made with ❤️ by [Alam Jamal](https://github.com/alamjamal)
+
+</div>

package/dist/database.d.ts

@@ -0,0 +1,36 @@
+/**
+ * WynkJS Database Pattern - EXAMPLE ONLY
+ *
+ * ⚠️ This file is NOT exported from WynkJS core.
+ * It's just an example pattern you can COPY to your project and customize.
+ *
+ * WHY NOT INCLUDED IN CORE?
+ * - Keeps WynkJS lightweight and fast (20x faster than NestJS!)
+ * - Gives you freedom to use ANY database library (Drizzle, Prisma, TypeORM, Mongoose, etc.)
+ * - No vendor lock-in
+ * - No unnecessary dependencies
+ *
+ * RECOMMENDED APPROACH:
+ * Use initializeDatabase() and getDatabase() from database.decorators.ts
+ * They're lightweight helpers already included in WynkJS core.
+ *
+ * BUT IF YOU PREFER A CLASS PATTERN, COPY THIS TO YOUR PROJECT:
+ */
+export declare const DATABASE_CLASS_EXAMPLE = "\n// src/db/database.ts (COPY THIS TO YOUR PROJECT)\n\nimport { Pool } from \"pg\";\nimport { drizzle } from \"drizzle-orm/node-postgres\";\nimport { userTable, otpTable } from '../users/tables';\n\nconst schema = { userTable, otpTable };\n\nexport class Database {\n  private static instance: any;\n  private static pool: Pool;\n\n  public static getInstance() {\n    if (!this.instance) {\n      this.pool = new Pool({\n        connectionString: process.env.DATABASE_URL!,\n        max: 20,\n        idleTimeoutMillis: 30000,\n        connectionTimeoutMillis: 2000,\n        ssl: { rejectUnauthorized: false },\n      });\n\n      this.instance = drizzle(this.pool, {\n        schema,\n        logger: true,\n      });\n\n      console.log(\"\u2705 Database connected\");\n    }\n    return this.instance;\n  }\n\n  public static async close() {\n    if (this.pool) {\n      await this.pool.end();\n      this.instance = null;\n      console.log(\"Database connection closed\");\n    }\n  }\n}\n\n// Usage in your index.ts:\n// import { Database } from './db/database';\n// const db = Database.getInstance();\n\n// Usage in your services:\n// import { Database } from '../db/database';\n// const db = Database.getInstance();\n// const users = await db.select().from(userTable);\n";
+/**
+ * Example for other database libraries
+ */
+export declare const PRISMA_EXAMPLE = "\n// With Prisma (COPY TO YOUR PROJECT)\n\nimport { PrismaClient } from '@prisma/client';\n\nexport class Database {\n  private static instance: PrismaClient;\n\n  public static getInstance() {\n    if (!this.instance) {\n      this.instance = new PrismaClient();\n      console.log(\"\u2705 Prisma connected\");\n    }\n    return this.instance;\n  }\n\n  public static async close() {\n    if (this.instance) {\n      await this.instance.$disconnect();\n      console.log(\"Prisma disconnected\");\n    }\n  }\n}\n";
+export declare const TYPEORM_EXAMPLE = "\n// With TypeORM (COPY TO YOUR PROJECT)\n\nimport { DataSource } from 'typeorm';\nimport { User, Post } from './entities';\n\nexport class Database {\n  private static instance: DataSource;\n\n  public static async getInstance() {\n    if (!this.instance) {\n      this.instance = new DataSource({\n        type: 'postgres',\n        url: process.env.DATABASE_URL,\n        entities: [User, Post],\n        synchronize: false,\n      });\n      await this.instance.initialize();\n      console.log(\"\u2705 TypeORM connected\");\n    }\n    return this.instance;\n  }\n\n  public static async close() {\n    if (this.instance?.isInitialized) {\n      await this.instance.destroy();\n      console.log(\"TypeORM disconnected\");\n    }\n  }\n}\n";
+export declare const MONGOOSE_EXAMPLE = "\n// With Mongoose (COPY TO YOUR PROJECT)\n\nimport mongoose from 'mongoose';\n\nexport class Database {\n  public static async connect() {\n    if (mongoose.connection.readyState === 0) {\n      await mongoose.connect(process.env.MONGODB_URL!, {\n        maxPoolSize: 10,\n      });\n      console.log(\"\u2705 MongoDB connected\");\n    }\n  }\n\n  public static async close() {\n    await mongoose.connection.close();\n    console.log(\"MongoDB disconnected\");\n  }\n\n  public static getConnection() {\n    return mongoose.connection;\n  }\n}\n";
+/**
+ * README: How to use this file
+ *
+ * 1. Copy one of the examples above to your project (e.g., src/db/database.ts)
+ * 2. Customize it to your needs (connection string, pool config, etc.)
+ * 3. Import and use it in your services
+ *
+ * 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/database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../core/database.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,eAAO,MAAM,sBAAsB,swCAkDlC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,ygBAuB1B,CAAC;AAEF,eAAO,MAAM,eAAe,8uBA8B3B,CAAC;AAEF,eAAO,MAAM,gBAAgB,0iBAwB5B,CAAC;AAEF;;;;;;;;;GASG"}