Initial commit: Plane

Synced from upstream: 8853637e981ed7d8a6cff32bd98e7afe20f54362

packages/decorators/README.md

@@ -0,0 +1,95 @@
+# @plane/decorators
+
+A lightweight TypeScript decorator library for building Express.js controllers with a clean, declarative syntax.
+
+## Features
+
+- TypeScript-first design
+- Decorators for HTTP methods (GET, POST, PUT, PATCH, DELETE)
+- WebSocket support
+- Middleware support
+- No build step required - works directly with TypeScript files
+
+## Installation
+
+This package is part of the Plane workspace and can be used by adding it to your project's dependencies:
+
+```json
+{
+  "dependencies": {
+    "@plane/decorators": "workspace:*"
+  }
+}
+```
+
+## Usage
+
+### Basic REST Controller
+
+```typescript
+import { Controller, Get, Post, BaseController } from "@plane/decorators";
+import { Router, Request, Response } from "express";
+
+@Controller("/api/users")
+class UserController extends BaseController {
+  @Get("/")
+  async getUsers(req: Request, res: Response) {
+    return res.json({ users: [] });
+  }
+
+  @Post("/")
+  async createUser(req: Request, res: Response) {
+    return res.json({ success: true });
+  }
+}
+
+// Register routes
+const router = Router();
+const userController = new UserController();
+userController.registerRoutes(router);
+```
+
+### WebSocket Controller
+
+```typescript
+import { Controller, WebSocket, BaseWebSocketController } from "@plane/decorators";
+import { Request } from "express";
+import { WebSocket as WS } from "ws";
+
+@Controller("/ws/chat")
+class ChatController extends BaseWebSocketController {
+  @WebSocket("/")
+  handleConnection(ws: WS, req: Request) {
+    ws.on("message", (message) => {
+      ws.send(`Received: ${message}`);
+    });
+  }
+}
+
+// Register WebSocket routes
+const router = require("express-ws")(app).router;
+const chatController = new ChatController();
+chatController.registerWebSocketRoutes(router);
+```
+
+## API Reference
+
+### Decorators
+
+- `@Controller(baseRoute: string)` - Class decorator for defining a base route
+- `@Get(route: string)` - Method decorator for HTTP GET endpoints
+- `@Post(route: string)` - Method decorator for HTTP POST endpoints
+- `@Put(route: string)` - Method decorator for HTTP PUT endpoints
+- `@Patch(route: string)` - Method decorator for HTTP PATCH endpoints
+- `@Delete(route: string)` - Method decorator for HTTP DELETE endpoints
+- `@WebSocket(route: string)` - Method decorator for WebSocket endpoints
+- `@Middleware(middleware: RequestHandler)` - Method decorator for applying middleware
+
+### Classes
+
+- `BaseController` - Base class for REST controllers
+- `BaseWebSocketController` - Base class for WebSocket controllers
+
+## License
+
+This project is licensed under the [GNU Affero General Public License v3.0](https://github.com/makeplane/plane/blob/master/LICENSE.txt).