@razvan11/paladin 1.1.3 → 1.1.5

package/README.md

@@ -1,15 +1,219 @@
-# backend_framwork
+# @razvan11/paladin
 
-To install dependencies:
+A modern, decorator-based backend framework for Bun with dependency injection, controller registration, and WebSocket support.
+
+## Features
+
+- **Decorator-based routing** - Clean, expressive route definitions
+- **Dependency Injection** - Powered by Inversify
+- **Built for Bun** - Leverages Bun's performance
+- **WebSocket support** - First-class WebSocket handling
+- **React SSR** - Server-side rendering utilities
+- **Middleware support** - Per-route middleware functions
+- **Static file serving** - Built-in asset handling
+
+## Installation
 
 ```bash
-bun install
+bun add @razvan11/paladin
 ```
 
-To run:
+## Quick Start
 
-```bash
-bun run index.ts
+```typescript
+import { App, controller, get, post, service, inject } from '@razvan11/paladin';
+
+@service()
+class UserService {
+  getUsers() {
+    return [{ id: 1, name: 'John' }];
+  }
+}
+
+@controller('/users')
+class UserController {
+  constructor(@inject(UserService) private userService: UserService) {}
+
+  @get('/')
+  async list(c: Context) {
+    return c.json(this.userService.getUsers());
+  }
+
+  @post('/')
+  async create(c: Context) {
+    const body = await c.req.json();
+    return c.json({ created: body });
+  }
+}
+
+const app = new App({ name: 'MyApp' });
+app.registerController(UserController);
+app.run();
 ```
 
-This project was created using `bun init` in bun v1.3.5. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+## Decorators
+
+### Controller Decorators
+
+| Decorator | Description |
+|-----------|-------------|
+| `@controller(prefix)` | Marks a class as a controller with a route prefix |
+| `@get(path, ...middlewares)` | Handles GET requests |
+| `@post(path, ...middlewares)` | Handles POST requests |
+| `@put(path, ...middlewares)` | Handles PUT requests |
+| `@patch(path, ...middlewares)` | Handles PATCH requests |
+| `@del(path, ...middlewares)` | Handles DELETE requests |
+| `@options(path, ...middlewares)` | Handles OPTIONS requests |
+| `@all(path, ...middlewares)` | Handles all HTTP methods |
+
+### Service Decorators
+
+| Decorator | Description |
+|-----------|-------------|
+| `@service()` | Marks a class as a service (singleton) |
+| `@repository()` | Marks a class as a repository (singleton) |
+| `@database(options)` | Marks a class as a database connection |
+
+### WebSocket Decorators
+
+| Decorator | Description |
+|-----------|-------------|
+| `@websocket(path)` | Marks a class as a WebSocket handler |
+| `@onMessage()` | Handles incoming messages |
+| `@onOpen()` | Handles connection open |
+| `@onClose()` | Handles connection close |
+| `@onDrain()` | Handles backpressure drain |
+
+## Dependency Injection
+
+Use the `@inject()` decorator to inject dependencies into your controllers and services:
+
+```typescript
+@controller('/api')
+class ApiController {
+  constructor(
+    @inject(UserService) private userService: UserService,
+    @inject(AuthService) private authService: AuthService,
+  ) {}
+}
+```
+
+## Middleware
+
+Add middleware to individual routes:
+
+```typescript
+const authMiddleware = async (c: Context, next: Next) => {
+  const token = c.req.header('Authorization');
+  if (!token) return c.json({ error: 'Unauthorized' }, 401);
+  await next();
+};
+
+@controller('/protected')
+class ProtectedController {
+  @get('/', authMiddleware)
+  async secure(c: Context) {
+    return c.json({ message: 'Secret data' });
+  }
+}
+```
+
+## WebSockets
+
+```typescript
+import { websocket, onMessage, onOpen, onClose } from '@razvan11/paladin';
+
+@websocket('/chat')
+class ChatHandler {
+  @onOpen()
+  handleOpen(ws: ServerWebSocket) {
+    console.log('Client connected');
+  }
+
+  @onMessage()
+  handleMessage(ws: ServerWebSocket, message: string | Buffer) {
+    ws.send(`Echo: ${message}`);
+  }
+
+  @onClose()
+  handleClose(ws: ServerWebSocket) {
+    console.log('Client disconnected');
+  }
+}
+
+const app = new App({ name: 'ChatApp' });
+app.registerWebSocket(ChatHandler);
+app.run();
+```
+
+## Static Files
+
+```typescript
+const app = new App({ name: 'MyApp' });
+
+app.serveStatic({
+  path: '/static',
+  root: './public'
+});
+```
+
+Use the `asset()` helper to generate URLs:
+
+```typescript
+import { asset } from '@razvan11/paladin';
+
+asset('dist', 'app.js'); // Returns '/static/dist/app.js'
+```
+
+## React SSR
+
+Render React components on the server:
+
+```typescript
+import { render, LayoutView } from '@razvan11/paladin';
+
+@controller('/')
+class IndexController {
+  @get('/')
+  index(c: Context) {
+    return render(c, LayoutView, {
+      title: 'My App',
+      scripts: [asset('dist', 'app.js')],
+      styles: [asset('dist', 'app.css')],
+      children: <div id="root" />,
+    });
+  }
+}
+```
+
+## Configuration
+
+```typescript
+const app = new App({
+  name: 'MyApp',
+  cors: ['https://example.com'], // CORS origins (default: ['*'])
+  validators: myValidators, // Optional validators
+});
+```
+
+Environment variables:
+- `PORT` - Server port (default: 3000)
+- `APP_ENV` - Environment mode (`local`, `development`, `staging`, `production`)
+
+## API Reference
+
+### App
+
+| Method | Description |
+|--------|-------------|
+| `registerController(Controller)` | Register a controller class |
+| `registerControllers(...Controllers)` | Register multiple controllers |
+| `registerWebSocket(WSHandler)` | Register a WebSocket handler |
+| `registerWebSockets(...WSHandlers)` | Register multiple WebSocket handlers |
+| `serveStatic(options)` | Serve static files |
+| `getAppInstance()` | Get the underlying Hono instance |
+| `run()` | Start the server |
+
+## License
+
+MIT © Razvan

package/dist/app/app.d.ts

@@ -19,7 +19,6 @@ export declare class App {
     private cors;
     private logger;
     private wsHandlers;
-    private server;
     constructor(options: AppConfigOptions);
     init(): void;
     /**

package/dist/functions/controller.d.ts

@@ -7,7 +7,7 @@ export interface RouteDefinition {
     handlerName: string | symbol;
     middlewares: MiddlewareHandler[];
 }
-export type MiddlewareHandler = (c: Context, next: Next) => Promise<Response | void> | Response | void;
+export type MiddlewareHandler = (c: Context, next: Next) => Promise<Response> | Promise<void> | Response | void;
 /**
  * @controller decorator
  * Marks a class as a controller and registers it with the DI container

package/dist/functions/render.d.ts

@@ -18,10 +18,6 @@ export declare function render<P extends object>(c: Context, Component: FC<P>, p
  * @returns HTML response
  */
 export declare function renderElement(c: Context, element: ReactElement): Response;
-/**
- * Create a render function bound to a context
- * Useful for cleaner controller code
- */
 export declare function createRenderer(c: Context): {
     render: <P extends object>(Component: FC<P>, props?: P) => Response;
     renderElement: (element: ReactElement) => Response;

package/dist/index.js

@@ -19887,7 +19887,6 @@ class App {
   cors;
   logger;
   wsHandlers = new Map;
-  server = null;
   constructor(options2) {
     this.app = new Hono2;
     this.name = options2.name;
@@ -19925,8 +19924,6 @@ class App {
       } else {
         app[route.method](fullPath, handler);
       }
-      if (Bun.env.APP_ENV === "local")
-        this.logger.info(`  ${route.method.toUpperCase().padEnd(7)} ${fullPath}`);
     }
     return this;
   }
@@ -19976,9 +19973,9 @@ class App {
     });
     try {
       const server = Bun.serve({
-        port: 3000,
-        hostname: "localhost",
-        development: false,
+        port: Bun.env.PORT ? parseInt(Bun.env.PORT, 10) : 3000,
+        hostname: "0.0.0.0",
+        development: Bun.env.APP_ENV === "local",
         fetch(req, server2) {
           const url = new URL(req.url);
           if (wsPaths.has(url.pathname)) {
@@ -20015,7 +20012,6 @@ class App {
           }
         }
       });
-      this.server = server;
       this.logger.success(`Server started on port ${server.port}`);
       return server;
     } catch (error) {
@@ -20076,7 +20072,7 @@ function getDataSourceForCLI(DatabaseClass, url) {
   const source = instance.getSource();
   if (options2?.migrations) {
     source.setOptions({
-      migrations: [options2.migrations + "/*.ts"],
+      migrations: [`${options2.migrations}/*.ts`],
       migrationsTableName: options2.migrationsTable || "migrations"
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@razvan11/paladin",
-	"version": "1.1.3",
+	"version": "1.1.5",
 	"description": "A Bun-based backend framework with decorators, dependency injection, and controller registration",
 	"keywords": [
 		"bun",
@@ -64,4 +64,5 @@
 		"reflect-metadata": "^0.2.2",
 		"zod": "^4.2.1"
 	}
-}
+}
+