@increase21/simplenodejs 1.1.1 → 2.0.0

package/README.md

@@ -97,39 +97,44 @@ Controllers are auto-loaded from `controllersDir` at startup. The file path maps
 
 ```
 controllers/
-  users/
-    auth.ts           → /users/auth
-    profile.ts        → /users/profile
   drivers/
-    vehicles.ts       → /drivers/vehicles
-    accountProfiles    → /drivers/account-profiles
+      auths.ts        → /users/auths
+
+  customers/
+      auths.ts       → /customers/auths
+      accounts      → /customers/accounts
 ```
 
-Controllers are plain classes — no base class required. Each method represents an endpoint and returns an array of `SimpleJsEndpointDescriptor` objects that declare which HTTP methods are supported and which handler to call.
+Controllers are plain classes — no base class required. Each method represents an endpoint and returns a `SimpleJsEndpoint` (an array of `SimpleJsEndpointDescriptor` objects) that declares which HTTP methods are supported and which handler to call.
+
+Every controller receives the request context (`SimpleJsCtx`) via its constructor and it is also available as `this.ctx` anywhere inside the class — in endpoint methods, descriptor handlers, and private helpers.
 
 ```ts
 // controllers/drivers/auths.ts
-import { SimpleJsCtx, SimpleJsEndpointDescriptor } from "@increase21/simplenodejs";
+import { SimpleJsCtx, SimpleJsEndpoint } from "@increase21/simplenodejs";
 
 export default class AuthController {
+  ctx: SimpleJsCtx;
 
-  async login(_ctx: SimpleJsCtx): Promise<SimpleJsEndpointDescriptor[]> {
-    return [
-      { method: "get",    handler: getLogin, middleware:LoginGetMiddleware },
-      { method: "post",   handler: postLogin, middleware:LoginPostMiddleware },
-    ];
+  // single HTTP method — access this.ctx directly, no descriptor needed
+  async login(): Promise<void> {
+    if (this.ctx.method !== "post") return this.ctx.res.status(405).json({ error: "Method Not Allowed" });
+    // handler logic...
   }
 
-  async account(_ctx: SimpleJsCtx, id: string): Promise<SimpleJsEndpointDescriptor[]> {
+  // multiple HTTP methods — return a SimpleJsEndpoint array
+  async vehicleList(id?: string): Promise<SimpleJsEndpoint> {
     return [
-      { method: "get",    id: "optional",  handler: getAccount },
-      { method: "put",    id: "required",  handler: updateAccount },
-      { method: "delete", id: "required",  handler: deleteAccount },
+      { method: "get",    id: "optional", handler: getVehicles },
+      { method: "put",    id: "required", handler: updateVehicle },
+      { method: "delete", id: "required", handler: deleteVehicle },
     ];
   }
 }
 ```
 
+> `this.ctx` is injected automatically by the router on every request. You do not need to pass it around manually — it is always available anywhere in the class.
+
 ### Endpoint Naming
 
 Controller methods use **camelCase** and are exposed as **kebab-case** URLs.
@@ -145,22 +150,17 @@ Controller methods use **camelCase** and are exposed as **kebab-case** URLs.
 Declare `id` in the endpoint method signature to indicate it accepts an ID segment. Use the descriptor's `id` field to enforce whether it is required or optional at the routing level.
 
 ```ts
-// GET  /drivers/auths/account        → id is optional
-// GET  /drivers/auths/account/123    → id = "123"
-// PUT  /drivers/auths/account/123    → required, 404 if missing
-async account(_ctx: SimpleJsCtx, id?: string): Promise<SimpleJsEndpointDescriptor[]> {
-  return [
-    { method: "get", id: "optional", handler: getAccount },
-    { method: "put", id: "required", handler: updateAccount },
-  ];
-}
+// GET  /drivers/auths/vehicle-list         → id is optional
+// GET  /drivers/auths/vehicle-list/123     → id = "123"
+// PUT  /drivers/auths/vehicle-list/123     → required, 404 if missing
+// DELETE  /drivers/auths/vehicle-list/123  → required, 404 if missing
 ```
 
 ---
 
 ## SimpleJsCtx
 
-The context object passed to every endpoint method and handler.
+The context object passed to every endpoint method and handler. Accepts an optional generic type `T` for `customData`.
 
 | Property | Type | Description |
 |---|---|---|
@@ -168,18 +168,28 @@ The context object passed to every endpoint method and handler.
 | `res` | `ResponseObject` | Raw response object |
 | `body` | `object` | Parsed request body |
 | `query` | `object` | Parsed query string |
-| `customData` | `any` | Data attached by plugins/middlewares via `req._custom_data` |
+| `method` | `HttpMethod` | HTTP method of the request (`"get"`, `"post"`, etc.) |
+| `customData` | `T` (default `any`) | Data attached by plugins/middlewares via `req._custom_data` |
+
+```ts
+// Typed customData
+const cookies = (ctx as SimpleJsCtx<{ cookies: Record<string, string> }>).customData.cookies;
+```
+
+## SimpleJsEndpoint
+
+`SimpleJsEndpoint` is the return type for controller endpoint methods. It is equivalent to `SimpleJsEndpointDescriptor[]`.
 
 ## SimpleJsEndpointDescriptor
 
-Returned by endpoint methods to declare HTTP method handlers.
+Each object in the `SimpleJsEndpoint` array describes one HTTP verb handler.
 
 | Property | Type | Required | Description |
 |---|---|---|---|
 | `method` | `HttpMethod` | ✅ | HTTP verb: `"get"`, `"post"`, `"put"`, `"patch"`, `"delete"` |
 | `handler` | `(ctx, id?) => any` | ✅ | Method reference to call for this HTTP verb |
 | `id` | `"required" \| "optional"` | ❌ | ID routing rule. Omit if the endpoint never uses an ID |
-| `middleware` | `(req, res, next)` | ❌ | A function to execute before the handler is called |
+| `middleware` | `Middleware[]` | ❌ | Array of middlewares to run before the handler |
 
 ---
 
@@ -189,9 +199,6 @@ Extends Node's `IncomingMessage` with additional properties.
 
 | Property | Type | Description |
 |---|---|---|
-| `req.url` | `string` | Full request URL |
-| `req.method` | `string` | HTTP method |
-| `req.headers` | `object` | Request headers |
 | `req.query` | `object` | Parsed query string parameters |
 | `req.body` | `any` | Parsed request body (set by `SetBodyParser`) |
 | `req.id` | `string` | Auto-generated UUID for the request (also sent as `X-Request-Id` header) |

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { CreateSimpleJsHttpServer, CreateSimpleJsHttpsServer } from "./server";
 export { SetCORS, SetHSTS, SetCSP, SetFrameGuard, SetNoSniff, SetReferrerPolicy, SetPermissionsPolicy, SetCOEP, SetCOOP, SetHelmet, SetRateLimiter, SetBodyParser, } from "./utils/simpleMiddleware";
 export * from "./utils/simplePlugins";
 export type { RequestObject, ResponseObject } from "./typings/general";
-export type { SimpleJsCtx, SimpleJsEndpointDescriptor, SimpleJsHttpsServer, Middleware as SimpleJsMiddleware, ErrorMiddleware as SimpleJsErrorMiddleware } from "./typings/simpletypes";
+export type { SimpleJsCtx, SimpleJsEndpoint, SimpleJsHttpsServer, Middleware as SimpleJsMiddleware, ErrorMiddleware as SimpleJsErrorMiddleware } from "./typings/simpletypes";

package/dist/router.js

@@ -23,6 +23,7 @@ async function route(req, res) {
         req, res,
         body: req.body,
         query: req.query,
+        method: httpMethod,
         customData: req._custom_data,
     };
     const ControllerClass = meta.Controller;
@@ -50,6 +51,8 @@ async function route(req, res) {
     if (id.length && (!controller[methodName].length || controller[methodName].length === 1)) {
         return (0, helpers_1.throwHttpError)(404, "Resource not found");
     }
+    //also add the context to the controller instance so that it can be accessed in the methods without passing it as a parameter
+    controller.ctx = ctx;
     const descriptors = await controller[methodName](ctx, ...id);
     // If the controller method has already sent a response, do not proceed
     if (res.writableEnded)
@@ -66,6 +69,13 @@ async function route(req, res) {
         return (0, helpers_1.throwHttpError)(404, "Resource not found");
     if (descriptor.id === "required" && !id.length)
         return (0, helpers_1.throwHttpError)(404, "Resource not found");
+    // Run endpoint-level middlewares before the handler
+    if (descriptor.middleware?.length) {
+        await (0, helpers_1.composeMiddleware)(descriptor.middleware)(req, res);
+    }
+    // If the handler has already sent a response, do not proceed
+    if (res.writableEnded)
+        return;
     // bind to controller so `this` works in regular methods too
     await descriptor.handler.bind(controller)(ctx, ...id);
     if (!res.writableEnded)

package/dist/typings/general.d.ts

@@ -3,15 +3,15 @@ export type HttpMethod = "get" | "post" | "put" | "patch" | "delete";
 export type ObjectPayload = {
     [key: string]: any;
 };
-export type RequestObject = IncomingMessage & {
+export interface RequestObject extends IncomingMessage {
     body?: any;
     query?: any;
     id?: string;
     _end_point_path?: string[];
     _custom_data?: ObjectPayload;
-};
-export type ResponseObject = ServerResponse & {
+}
+export interface ResponseObject extends ServerResponse {
     status: (value: number) => ResponseObject;
     json: (value: object) => void;
     text: (value?: string) => void;
-};
+}

package/dist/typings/simpletypes.d.ts

@@ -39,15 +39,18 @@ export interface SimpleJsHttpsServer extends https.Server {
     useError: (mw: ErrorMiddleware) => void;
     registerPlugin: (plugin: Plugin) => Promise<any> | void;
 }
-export interface SimpleJsCtx {
+export interface SimpleJsCtx<T = any> {
     body: ObjectPayload;
     res: ResponseObject;
     req: RequestObject;
     query: ObjectPayload;
-    customData: any;
+    method: HttpMethod;
+    customData: T;
 }
 export interface SimpleJsEndpointDescriptor {
     method: HttpMethod;
     id?: "required" | "optional";
+    middleware?: Middleware[];
     handler: (ctx: SimpleJsCtx, id?: string) => any;
 }
+export type SimpleJsEndpoint = SimpleJsEndpointDescriptor[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@increase21/simplenodejs",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "description": "Lightweight Node.js HTTP framework with middlewares and plugins",
   "dev": "dist/index.js",
   "bugs": "https://github.com/increase21/simplenodejs/issues",
@@ -40,4 +40,4 @@
   "devDependencies": {
     "typescript": "^5.3.0"
   }
-}
+}