@titanpl/route 2.0.3 → 6.0.0

package/README.md

@@ -14,6 +14,9 @@ import t from "@titanpl/route";
 // Define an action-based route
 t.post("/hello").action("hello"); // pass a json payload { "name": "titan" }
 
+// Define a WebSocket route
+t.ws("/chat").action("chat");
+
 // Define a direct reply route
 t.get("/").reply("Ready to land on Titan Planet 🚀");
 
@@ -21,4 +24,22 @@ t.get("/").reply("Ready to land on Titan Planet 🚀");
 t.start(5100, "Titan Running!");
 ```
 
+### WebSocket Action Handling
+When using `t.ws()`, your action receives the `event`, `socketId`, and `body`:
+
+```javascript
+export const chat = (req) => {
+    const { event, socketId, body } = req;
+
+    if (event === "open") {
+        t.ws.send(socketId, "Connected to Titan Orbital Hub!");
+        t.ws.broadcast(`User ${socketId} has docked.`);
+    }
+
+    if (event === "message") {
+        t.ws.broadcast(`${socketId}: ${body}`);
+    }
+};
+```
+
 **Important Note:** Currently, Titan Planet and its entire package ecosystem are only for Windows. The Linux version is in development (dev only) for the new architecture and will be launched later.

package/index.d.ts

@@ -8,6 +8,7 @@ export interface TitanRoute {
     post(route: string): RouteBuilder;
     put(route: string): RouteBuilder;
     delete(route: string): RouteBuilder;
+    ws(route: string): { action(name: string): void };
     log(module: string, msg: string): void;
     start(port?: number, msg?: string, threads?: number, stack_mb?: number): void;
 }

package/index.js

@@ -42,6 +42,28 @@ const t = {
 
     start(port = 3000, msg = "", threads, stack_mb = 8) {
         globalThis.__TITAN_CONFIG__ = { port, msg, threads, stack_mb };
+    },
+
+    ws(route) {
+        return {
+            action(name) {
+                if (route.includes(":")) {
+                    if (!dynamicRoutes["WS"]) dynamicRoutes["WS"] = [];
+                    dynamicRoutes["WS"].push({
+                        method: "WS",
+                        pattern: route,
+                        action: name
+                    });
+                    actionMap[`WS:${route}`] = name;
+                } else {
+                    routes[`WS:${route}`] = {
+                        type: "websocket",
+                        value: name
+                    };
+                    actionMap[`WS:${route}`] = name;
+                }
+            }
+        };
     }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@titanpl/route",
-  "version": "2.0.3",
+  "version": "6.0.0",
   "description": "Titan routing DSL",
   "type": "module",
   "main": "index.js",