@increase21/simplenodejs 1.0.16 → 1.0.18

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)
@@ -63,10 +53,12 @@ Creates and returns the HTTP app instance.
 ```ts
 const app = CreateSimpleJsHttpServer({
   controllersDir: process.cwd()+ "/controllers",
+  trustProxy: true
 });
 
-app.listen(4000,callback)
-
+app.listen(3000, () => {
+  console.log("Server running on http://localhost:3000");
+});
 ```
 
 ---
@@ -74,7 +66,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 +85,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 +100,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,7 +144,7 @@ Methods can receive parameters, which are passed through the URL pathname. When
     patch?: 'required' | 'optional',
   }
 }
-  ```
+```
 
 ## 🧾 RequestObject (req)
 
@@ -215,7 +229,7 @@ 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
@@ -240,10 +254,10 @@ All the standard http headers
 
 ### Usage
 ```ts
-app.use(app=>SetRequestCORS(app, [{
+app.use(SetRequestCORS({
   "Access-Control-Allow-Origin": "*",
   "X-Frame-Options": "DENY",
-}]));
+}));
 ```
 
 ---

package/dist/router.d.ts

@@ -2,4 +2,4 @@ import { RequestObject, ResponseObject } from "./typings/general";
 import { SimpleJsControllerMeta } from "./typings/simpletypes";
 export declare function loadControllers(root?: string): Map<string, SimpleJsControllerMeta>;
 export declare function setControllersDir(dir: string): void;
-export declare function route(req: RequestObject, res: ResponseObject, controllersDir?: string): Promise<void>;
+export declare function route(req: RequestObject, res: ResponseObject): Promise<void>;

package/dist/router.js

@@ -9,6 +9,7 @@ exports.route = route;
 // router.ts
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
+const helpers_1 = require("./utils/helpers");
 let controllers = new Map();
 function loadControllers(root = "controllers") {
     const base = node_path_1.default.resolve(process.cwd(), root);
@@ -42,7 +43,7 @@ function loadControllers(root = "controllers") {
 function setControllersDir(dir) {
     controllers = loadControllers(dir);
 }
-async function route(req, res, controllersDir) {
+async function route(req, res) {
     let parts = req._end_point_path || [];
     let controllerPath = (parts.length > 2 ? "/" + parts.slice(0, 2).join("/") : `/${parts.join("/")}`).toLocaleLowerCase();
     let methodName = parts.length > 2 ? parts[2] : "index";
@@ -50,7 +51,7 @@ async function route(req, res, controllersDir) {
     const meta = controllers.get(controllerPath);
     //if the controller is not available or not found
     if (!meta || !meta.name || !meta.Controller)
-        return res.status(404).json({ error: "The requested resource does not exist" });
+        return (0, helpers_1.throwHttpError)(404, "The requested resource does not exist");
     const ControllerClass = meta.Controller;
     const controller = new ControllerClass();
     //Update the method name to the framework pathen
@@ -63,12 +64,12 @@ async function route(req, res, controllersDir) {
             id = parts.slice(2);
         }
         else {
-            return res.status(404).json({ error: "The requested resource does not exist" });
+            return (0, helpers_1.throwHttpError)(404, "The requested resource does not exist");
         }
     }
     //if the data require params but there's no matching params
     if (id && id.length && (!controller[methodName].length || controller[methodName].length < id.length)) {
-        return res.status(404).json({ error: "The requested resource does not exist. Kindly check your url" });
+        return (0, helpers_1.throwHttpError)(404, "The requested resource does not exist");
     }
     //bind the controller to use the global properties
     controller.__bindContext({ req, res });

package/dist/utils/helpers.js

@@ -28,7 +28,6 @@ function composeWithError(middlewares) {
 }
 function throwHttpError(code, message) {
     const error = new Error(message);
-    error.statusCode = code;
     error.toJSON = () => ({ code, error: message });
     throw error;
 }

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,6 +1,6 @@
 {
   "name": "@increase21/simplenodejs",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "description": "Lightweight Node.js HTTP framework with middleware and plugins",
   "dev": "dist/index.js",
   "bugs": "https://github.com/increase21/simplenodejs/issues",