fastnode-cli 0.2.0 → 0.4.0

package/README.md

@@ -1,3 +1,11 @@
+<p align="center">
+  <img
+    src="https://res.cloudinary.com/dlvcthd0a/image/upload/v1773121010/fast_cgma5m.png"
+    alt="FastNode logo"
+    width="220"
+  />
+</p>
+
 # fastnode-cli
 
 `fastnode-cli` scaffolds FastNode applications and works with `fastnode-core`.
@@ -47,24 +55,33 @@ src/items/items.controller.ts
 
 ## What the Scaffold Includes
 
-The generated app now includes a simple execution policy example:
+The generated app now includes a minimal HTTP + Socket.IO setup:
 
 - app-level default execution policy in `createApp(...)`
 - controller-level policy with `@ExecutionPolicy(...)`
+- request-scoped execution helpers with `@Context()`
 - FastAPI-style path placeholders like `/{item_id}`
 - parameter decorators like `@Param()` and `@Query()`
+- one Socket.IO namespace controller with `@Subscribe()` and `@EmitToClient()`
+- Swagger docs available automatically at `/docs`
+- Socket.IO attached automatically at the default `/socket.io` path
 
 Example generated shape:
 
 ```ts
 import "reflect-metadata";
 import {
+  Body,
+  Context,
   Controller,
+  EmitToClient,
   ExecutionPolicy,
   Get,
   Module,
   Param,
   Query,
+  SocketController,
+  Subscribe,
   createApp,
 } from "fastnode-core";
 
@@ -72,9 +89,12 @@ import {
 @ExecutionPolicy({ timeout: 5000 })
 class HelloController {
   @Get("/")
-  hello(@Query("name") name?: string) {
+  async hello(@Query("name") name?: string, @Context() ctx?: any) {
+    await ctx?.sleep(25);
+
     return {
       message: `Hello from hello${name ? `, ${name}` : ""}`,
+      deadline: ctx?.snapshot?.().deadline,
     };
   }
 
@@ -84,7 +104,16 @@ class HelloController {
   }
 }
 
-@Module({ controllers: [HelloController] })
+@SocketController("/chat")
+class HelloSocketController {
+  @Subscribe("ping")
+  @EmitToClient()
+  ping(@Body("message") message?: string) {
+    return { message: message ?? "pong" };
+  }
+}
+
+@Module({ controllers: [HelloController, HelloSocketController] })
 class HelloModule {}
 
 createApp([HelloModule], {
@@ -99,15 +128,23 @@ Generated controller files also include request-data examples for:
 
 - `@Param("id")`
 - `@Query("page")`
+- `@Post("/")`
 - `@Body()`
 - `@Body("name")`
 
 ## Related Docs
 
-See `packages/core/README.md` for the full execution policy guide, including:
+See `packages/core/README.md` for the full framework guide, including:
 
 - `@ExecutionPolicy()`
 - `@UseExecutionPolicy()`
+- `@Context()`
+- `@IsolatedInput()`
 - `@IsolatedHandler()`
+- `@SocketController()`
+- `@Subscribe()`
+- `@UseGuard()`
+- `@UseRateLimit()`
+- `@UseValidation()`
 - inline vs isolated execution
-- timeout response behavior
+- socket event handling and room broadcasts

package/dist/index.js

@@ -89,12 +89,18 @@ function buildMainTemplate(projectName) {
     const moduleName = `${toPascalCase(projectName)}Module`;
     return `import "reflect-metadata";
 import {
+  Body,
+  Context,
   Controller,
+  EmitToClient,
   ExecutionPolicy,
   Get,
   Module,
   Param,
+  Post,
   Query,
+  SocketController,
+  Subscribe,
   createApp,
 } from "fastnode-core";
 
@@ -102,9 +108,15 @@ import {
 @ExecutionPolicy({ timeout: 5000 })
 class ${className} {
   @Get("/")
-  hello(@Query("name") name?: string) {
+  async hello(
+    @Query("name") name?: string,
+    @Context() ctx?: any
+  ) {
+    await ctx?.sleep(25);
+
     return {
       message: \`Hello from ${projectName}\${name ? \`, \${name}\` : ""}\`,
+      deadline: ctx?.snapshot?.().deadline,
     };
   }
 
@@ -118,9 +130,27 @@ class ${className} {
       include,
     };
   }
+
+  @Post("/")
+  create() {
+    return {
+      created: true,
+    };
+  }
+}
+
+@SocketController("/chat")
+class ${toPascalCase(projectName)}SocketController {
+  @Subscribe("ping")
+  @EmitToClient()
+  ping(@Body("message") message?: string) {
+    return {
+      message: message ?? "pong",
+    };
+  }
 }
 
-@Module({ controllers: [${className}] })
+@Module({ controllers: [${className}, ${toPascalCase(projectName)}SocketController] })
 class ${moduleName} {}
 
 createApp([${moduleName}], {
@@ -137,6 +167,7 @@ function buildControllerTemplate(controllerName) {
   Body,
   Controller,
   Get,
+  Post,
   Param,
   Query,
 } from "fastnode-core";
@@ -166,8 +197,8 @@ export class ${className} {
     };
   }
 
-  @Get("/request/echo")
-  echoRequest(
+  @Post("/")
+  create(
     @Body() payload?: Record<string, unknown>,
     @Body("name") name?: string
   ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastnode-cli",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "The official CLI for scaffolding and serving FastNode applications.",
   "bin": {
     "fastnode": "dist/index.js"
@@ -25,7 +25,7 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^11.0.0",
-    "fastnode-core": "^0.2.0",
+    "fastnode-core": "^0.4.0",
     "reflect-metadata": "^0.1.13"
   },
   "devDependencies": {