@increase21/simplenodejs 1.0.17 → 1.0.19

package/README.md

@@ -33,17 +33,7 @@ npm install @increase21/simplenodejs
 
 ```ts
 import { CreateSimpleJsHttpServer } from "@increase21/simplenodejs";
-
-const app = CreateSimpleJsHttpServer({
-  controllersDir: process.cwd()+ "/controllers",
-  trustProxy: true
-});
-
-app.listen(3000, () => {
-  console.log("Server running on http://localhost:3000");
-});
 ```
-
 ---
 
 ## ⚙️ CreateSimpleJsHttpServer(options)
@@ -65,8 +55,9 @@ const app = CreateSimpleJsHttpServer({
   controllersDir: process.cwd()+ "/controllers",
 });
 
-app.listen(4000,callback)
-
+app.listen(3000, () => {
+  console.log("Server running on http://localhost:3000");
+});
 ```
 
 ---
@@ -74,7 +65,7 @@ app.listen(4000,callback)
 ## 📁 Controllers
 
 Controllers are auto-loaded from `controllersDir`.
-#### Running Multiple Methods
+#### Running an endpoint using RunRequest
 ##### ./controllers/{servicefolder}/auth.ts 
 #### or
 #### ./controllers/{servicefolder}/auth.js
@@ -93,9 +84,11 @@ export default AuthControllers extends SimpleNodeJsController {
   }
 };
 ```
-Available on POST|GET|PUT|DELETE at http://baseURl/{servicefolder}/auth/account
 
-#### Running Single Method
+The above endpoint is accessible on http://baseURl/{servicefolder}/auth/account.
+The endpoint receives optional parameter (id:string) which can be passed in the url e.g http://baseURl/{servicefolder}/auth/account/{id}
+
+#### Running an endpoint without RunRequest
 ```ts
 export default AuthControllers extends SimpleNodeJsController {
 
@@ -106,6 +99,26 @@ export default AuthControllers extends SimpleNodeJsController {
   }
 };
 ```
+### Endpoint Naming
+Endpoints are defined using camelCase method names in controller files and are exposed as kebab-case in the URL path.
+```ts
+async vehicleList(id:string) {}
+```
+
+```code
+/vehicle-list
+/vehicle-list/{id}
+```
+
+```ts
+async vehicle() {}
+```
+
+```code
+/vehicle
+```
+
+---
 
 ### Controller Object Params
 Each method defined in a controller file is exposed as an endpoint by SimpleNodeJsController.
@@ -130,13 +143,13 @@ Methods can receive parameters, which are passed through the URL pathname. When
     patch?: 'required' | 'optional',
   }
 }
-  ```
+```
 
 ## 🧾 RequestObject (req)
 
-Available on every route handler.
+Available on every controller.
 
-| Property | Type | Description |
+| Additional Properties | Type | Description |
 |---------|------|-------------|
 | `req.url` | `string` | Request URL |
 | `req.method` | `string` | HTTP method |
@@ -149,7 +162,7 @@ Available on every route handler.
 
 ## 🧾 ResponseObject (res)
 
-| Method | Params | Description |
+| Additional Methods | Params | Description |
 |--------|--------|-------------|
 | `res.status(code)` | `number` | Set HTTP status |
 | `res.json(data)` | `any` | Send JSON response |
@@ -171,15 +184,15 @@ Registers a middleware that runs before controllers.
 ### Middleware Signature
 
 ```ts
-(req: RequestObject, res: ResponseObject, next: () => Promise<void> | void) => Promise<void> | void
+(req: RequestObject, res: ResponseObject, next: () => Promise<void> | void) => Promise<any> | void
 ```
 
 ### Example
 
 ```ts
-app.use(async (req, res, next) => {
+app.use((req, res, next) => {
   console.log(req.method, req.url);
-  await next();
+   next();
 });
 ```
 
@@ -189,7 +202,7 @@ app.use(async (req, res, next) => {
 
 Registers a global error handler.
 
-### Signature
+### ErrorHandler
 app.useError() registers global error-handling middleware.
 It catches all errors thrown anywhere in the request lifecycle — including:
 	•	Errors thrown inside middlewares
@@ -215,17 +228,17 @@ Registers a plugin.
 ### Plugin Shape
 
 ```ts
-type Plugin = (app: SimpleJsServer, opts?: any) => void | Promise<void>;
+type Plugin = (app: SimpleJsServer, opts?: any) =>  Promise<any>|void;
 ```
 
 ### Built-In Plugins
 
-| name      | Description |
+| name      | Description |   Status  | 
 |-----------|-------------|
-| `SimpleJsSecurityPlugin` | CORS, RateLimit, Helmet |
-| `SimpleJsJWTPlugin` | JWT protection|
-| `SimpleJsIPWhitelistPlugin` | Restricting IP addresses |
-| `SimpleJsCookiePlugin` | Restricting IP addresses |
+| `SimpleJsSecurityPlugin` | CORS, RateLimit, Helmet | Available |
+| `SimpleJsJWTPlugin` | JWT protection|   Coming soon |
+| `SimpleJsIPWhitelistPlugin` | Restricting IP addresses |  Coming soon |
+| `SimpleJsCookiePlugin` | Cookies Plugin | Coming soon |
 
 ---
 
@@ -240,10 +253,10 @@ All the standard http headers
 
 ### Usage
 ```ts
-app.use(app=>SetRequestCORS(app, [{
+app.use(SetRequestCORS({
   "Access-Control-Allow-Origin": "*",
   "X-Frame-Options": "DENY",
-}]));
+}));
 ```
 
 ---
@@ -287,7 +300,7 @@ app.use(SetBodyParser({ limit: "2mb" }));
 - Always enable `SetSecurityHeaders`
 - Enable `SetRateLimiter` on public APIs
 - Validate request body
-- Use `trustProxy: true` only behind trusted proxies
+<!-- - Use `trustProxy: true` only behind trusted proxies -->
 - Avoid leaking stack traces in production
 
 ---

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { SimpleNodeJsController } from "./utils/simpleController";
 export { CreateSimpleJsHttpServer } from "./server";
 export { SetRequestCORS, SetRateLimiter, SetBodyParser } from "./utils/simpleMiddleware";
 export * from "./utils/simplePlugins";
-export type { SimpleJsPrivateMethodProps } from "./typings/general";
+export type { SimpleJsPrivateMethodProps, Middleware as SimpleJsMiddleware } from "./typings/general";

package/dist/typings/general.d.ts

@@ -5,7 +5,7 @@ export type HttpMethod = "get" | "post" | "put" | "patch" | "delete";
 export type ObjectPayload = {
     [key: string]: any;
 };
-export type Middleware = (req: RequestObject, res: ResponseObject, next: () => Promise<any> | void, errorHandler?: () => void) => Promise<any> | void;
+export type Middleware = (req: RequestObject, res: ResponseObject, next: () => Promise<any> | void) => Promise<any> | void;
 export type ErrorMiddleware = (err: any, req: RequestObject, res: ResponseObject, next: Next) => Promise<boolean> | void;
 export interface SimpleJsServer extends http.Server {
     use(mw: Middleware): Promise<any> | void;

package/dist/utils/simpleController.d.ts

@@ -14,6 +14,6 @@ export declare class SimpleNodeJsController {
     }): void;
     /** framework-internal method */
     __checkContext(): void;
-    protected RunRequest(handlers: SubRequestHandler, params?: SimpleJsPrivateMethodProps): any;
+    protected RunRequest(handlers: SubRequestHandler, params?: Partial<SimpleJsPrivateMethodProps>): any;
 }
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@increase21/simplenodejs",
-  "version": "1.0.17",
-  "description": "Lightweight Node.js HTTP framework with middleware and plugins",
+  "version": "1.0.19",
+  "description": "Lightweight Node.js HTTP framework with middlewares and plugins",
   "dev": "dist/index.js",
   "bugs": "https://github.com/increase21/simplenodejs/issues",
   "main": "dist/index.js",