@increase21/simplenodejs 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -1,5 +1,3 @@
 export { CreateSimpleJsHttpServer } from "./server";
-export * from "./utils/helpers";
-export * from "./utils/simpleController";
-export * from "./utils/simplePlugins";
-export { Middleware, ErrorMiddleware, SimpleJsServer } from "./typings/general";
+export { SetRequestCORS, SetRateLimiter, SetBodyParser } from "./utils/helpers";
+export type { SimpleJsPrivateMethodProps } from "./typings/general";

package/dist/index.js

@@ -1,22 +1,9 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateSimpleJsHttpServer = void 0;
+exports.SetBodyParser = exports.SetRateLimiter = exports.SetRequestCORS = exports.CreateSimpleJsHttpServer = void 0;
 var server_1 = require("./server");
 Object.defineProperty(exports, "CreateSimpleJsHttpServer", { enumerable: true, get: function () { return server_1.CreateSimpleJsHttpServer; } });
-__exportStar(require("./utils/helpers"), exports);
-__exportStar(require("./utils/simpleController"), exports);
-__exportStar(require("./utils/simplePlugins"), exports);
+var helpers_1 = require("./utils/helpers");
+Object.defineProperty(exports, "SetRequestCORS", { enumerable: true, get: function () { return helpers_1.SetRequestCORS; } });
+Object.defineProperty(exports, "SetRateLimiter", { enumerable: true, get: function () { return helpers_1.SetRateLimiter; } });
+Object.defineProperty(exports, "SetBodyParser", { enumerable: true, get: function () { return helpers_1.SetBodyParser; } });

package/dist/router.d.ts

@@ -1,7 +1,5 @@
 import { RequestObject, ResponseObject } from "./typings/general";
-export interface ControllerMeta {
-    name: string;
-    Controller: any;
-}
-export declare function loadControllers(root?: string): Map<string, ControllerMeta>;
+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>;

package/dist/router.js

@@ -4,10 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadControllers = loadControllers;
+exports.setControllersDir = setControllersDir;
 exports.route = route;
 // router.ts
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
+let controllers = new Map();
 function loadControllers(root = "controllers") {
     const base = node_path_1.default.resolve(process.cwd(), root);
     const map = new Map();
@@ -37,7 +39,9 @@ function loadControllers(root = "controllers") {
     walk(base);
     return map;
 }
-const controllers = loadControllers();
+function setControllersDir(dir) {
+    controllers = loadControllers(dir);
+}
 async function route(req, res, controllersDir) {
     // console.log("Router is called")
     const url = new URL(req.url, "http://localhost");
@@ -66,7 +70,11 @@ async function route(req, res, controllersDir) {
     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" });
     }
-    controller._bindContext({ req, res });
+    //bind the controller to use the global properties
+    controller.__bindContext({ req, res });
+    ////if there's protected function to run
+    if (typeof controller.__checkContext === "function")
+        controller.__checkContext();
     const result = await controller[methodName](...(id || []));
     //if it's not responded
     if (!res.writableEnded && result) {

package/dist/server.d.ts

@@ -1,3 +1,5 @@
 import { IncomingMessage, ServerResponse } from "http";
 import { SimpleJsServer } from "./typings/general";
-export declare const CreateSimpleJsHttpServer: (handler?: (req: IncomingMessage, res: ServerResponse) => void) => SimpleJsServer;
+export declare const CreateSimpleJsHttpServer: (handler?: (req: IncomingMessage, res: ServerResponse) => void, opts?: {
+    controllersDir: string;
+}) => SimpleJsServer;

package/dist/server.js

@@ -29,10 +29,13 @@ const extension = (req, res) => {
     req.id = node_crypto_1.default.randomUUID();
     res.setHeader("X-Request-Id", req.id);
 };
-const CreateSimpleJsHttpServer = (handler) => {
+const CreateSimpleJsHttpServer = (handler, opts) => {
     const middlewares = [];
     const errorMiddlewares = [];
     const plugins = [];
+    //set the director of the controller
+    if (opts?.controllersDir)
+        (0, router_1.setControllersDir)(opts.controllersDir);
     const server = http_1.default.createServer(async (req, res) => {
         extension(req, res);
         const run = (0, helpers_1.composeWithError)(middlewares, errorMiddlewares);
@@ -60,9 +63,9 @@ const CreateSimpleJsHttpServer = (handler) => {
     });
     server.use = mw => { middlewares.push(mw); };
     server.useError = mw => errorMiddlewares.push(mw);
-    server.register = async (plugin, opts) => {
+    server.registerPlugin = async (plugin) => {
         plugins.push(plugin);
-        await plugin(server, opts);
+        await plugin(server);
     };
     return server;
 };

package/dist/typings/general.d.ts

@@ -1,6 +1,7 @@
 import http, { IncomingMessage, ServerResponse } from "http";
 export type Next = () => Promise<void> | void;
 export type Plugin = (app: SimpleJsServer, opts?: any) => Promise<void> | void;
+export type HttpMethod = "get" | "post" | "put" | "patch" | "delete";
 export type ObjectPayload = {
     [key: string]: any;
 };
@@ -9,14 +10,15 @@ export type ErrorMiddleware = (err: any, req: RequestObject, res: ResponseObject
 export interface SimpleJsServer extends http.Server {
     use(mw: Middleware): Promise<any> | void;
     useError: (mw: ErrorMiddleware) => void;
-    register: (plugin: Plugin, opts?: any) => Promise<void>;
+    registerPlugin: (plugin: Plugin) => Promise<void>;
     _environment: 'dev' | 'stag' | 'live';
 }
 export interface RequestObject extends IncomingMessage {
     body?: any;
     query?: any;
-    _server_environment?: 'dev' | 'stag' | 'live';
     id?: string;
+    _server_environment?: 'dev' | 'stag' | 'live';
+    _custom_data?: ObjectPayload;
 }
 export interface ResponseObject extends ServerResponse {
     status: (value: number) => ResponseObject;
@@ -24,13 +26,13 @@ export interface ResponseObject extends ServerResponse {
     text: (value?: string) => void;
 }
 export interface SubRequestHandler {
-    post?: (params: PrivateMethodProps) => void;
-    put?: (params: PrivateMethodProps) => void;
-    get?: (params: PrivateMethodProps) => void;
-    delete?: (params: PrivateMethodProps) => void;
-    patch?: (params: PrivateMethodProps) => void;
+    post?: (params: SimpleJsPrivateMethodProps) => void;
+    put?: (params: SimpleJsPrivateMethodProps) => void;
+    get?: (params: SimpleJsPrivateMethodProps) => void;
+    delete?: (params: SimpleJsPrivateMethodProps) => void;
+    patch?: (params: SimpleJsPrivateMethodProps) => void;
 }
-export interface PrivateMethodProps {
+export interface SimpleJsPrivateMethodProps {
     body: ObjectPayload;
     res: ResponseObject;
     req: RequestObject;

package/dist/typings/simpletypes.d.ts

@@ -6,3 +6,7 @@ export type SimpleJSRateLimitType = {
 export type SimpleJSBodyParseType = {
     limit?: string | number;
 };
+export interface SimpleJsControllerMeta {
+    name: string;
+    Controller: any;
+}

package/dist/utils/simpleController.d.ts

@@ -1,5 +1,4 @@
-import { RequestObject, ResponseObject } from "../typings/general";
-type HttpMethod = "get" | "post" | "put" | "patch" | "delete";
+import { HttpMethod, ObjectPayload, RequestObject, ResponseObject } from "../typings/general";
 type SubRequestHandler = Partial<Record<HttpMethod, (params: PrivateMethodProps) => any>>;
 interface PrivateMethodProps {
     id?: string;
@@ -8,11 +7,16 @@ interface PrivateMethodProps {
 export declare class SimpleNodeJsController {
     protected req: RequestObject;
     protected res: ResponseObject;
+    protected body: ObjectPayload;
+    protected query: ObjectPayload;
+    protected method: HttpMethod;
+    protected _custom_data: any;
     /** framework-internal method */
-    _bindContext(ctx: {
+    __bindContext(ctx: {
         req: RequestObject;
         res: ResponseObject;
     }): void;
+    __checkContext(): void;
     protected RunRequest(handlers: SubRequestHandler, params?: PrivateMethodProps): any;
 }
 export {};

package/dist/utils/simpleController.js

@@ -3,25 +3,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SimpleNodeJsController = void 0;
 class SimpleNodeJsController {
     /** framework-internal method */
-    _bindContext(ctx) {
+    __bindContext(ctx) {
         this.req = ctx.req;
         this.res = ctx.res;
+        this.body = ctx.req.body;
+        this.query = ctx.req.query;
+        this.method = (ctx.req.method || "").toLocaleLowerCase();
+        this._custom_data = ctx.req._custom_data;
     }
+    __checkContext() { }
     RunRequest(handlers, params) {
         const method = this.req.method?.toLowerCase();
         if (!method) {
-            return this.res.status(400).json({ code: 400, msg: "Invalid HTTP Method" });
+            return this.res.status(400).json({ code: 400, error: "Invalid HTTP Method" });
         }
         const runFn = handlers[method];
         if (typeof runFn !== "function") {
-            return this.res.status(405).json({ code: 405, msg: "Method Not Allowed" });
+            return this.res.status(405).json({ code: 405, error: "Method Not Allowed" });
         }
         // ID validation rules
         if (params && params.id && (!params.idMethod || !params.idMethod[method])) {
-            return this.res.status(404).json({ code: 404, msg: "Resource not found" });
+            return this.res.status(404).json({ code: 404, error: "Resource not found" });
         }
         if (params && params.idMethod?.[method] === "required" && !params.id) {
-            return this.res.status(404).json({ code: 404, msg: "Resource not found" });
+            return this.res.status(404).json({ code: 404, error: "Resource not found" });
         }
         return runFn({
             ...(params || {}),

package/dist/utils/simplePlugins.d.ts

@@ -1,6 +1,6 @@
 import { SimpleJsServer } from "../typings/general";
 import { SimpleJSRateLimitType } from "../typings/simpletypes";
-export declare function SecurityPlugin(app: SimpleJsServer, opts: {
+export declare function SimpleJsSecurityPlugin(app: SimpleJsServer, opts: {
     cors?: {
         name: string;
         value: string;

package/dist/utils/simplePlugins.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SecurityPlugin = SecurityPlugin;
+exports.SimpleJsSecurityPlugin = SimpleJsSecurityPlugin;
 const helpers_1 = require("./helpers");
-function SecurityPlugin(app, opts) {
-    app.use((0, helpers_1.SetRequestCORS)(opts.cors || []));
-    app.use((0, helpers_1.SetRateLimiter)(opts.rateLimit || { windowMs: 1000, max: 100 }));
+function SimpleJsSecurityPlugin(app, opts) {
+    opts.cors && app.use((0, helpers_1.SetRequestCORS)(opts.cors || []));
+    opts.rateLimit && app.use((0, helpers_1.SetRateLimiter)(opts.rateLimit || { windowMs: 1000, max: 100 }));
 }

package/package.json

@@ -1,17 +1,25 @@
 {
   "name": "@increase21/simplenodejs",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Lightweight Node.js HTTP framework with middleware and plugins",
   "dev": "dist/index.js",
   "bugs": "https://github.com/increase21/simplenodejs/issues",
+  "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/increase21/simplenodejs.git",
     "directory": ""
   },
   "files": [
-    "dist/**/*"
+    "dist"
   ],
   "scripts": {
     "build": "tsc",