npm - cpeak - Versions diffs - 2.2.5 → 2.4.0 - Mend

cpeak 2.2.5 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/README.md +134 -15
package/dist/index.d.ts +42 -0
package/dist/index.js +261 -0
package/dist/index.js.map +1 -0
package/lib/index.ts +219 -0
package/lib/types.ts +51 -0
package/lib/utils/index.ts +5 -0
package/lib/utils/parseJSON.ts +30 -0
package/lib/utils/render.ts +72 -0
package/lib/utils/{serveStatic.js → serveStatic.ts} +16 -11
package/package.json +22 -5
package/lib/index.js +0 -137
package/lib/utils/index.js +0 -4
package/lib/utils/parseJSON.js +0 -20

package/README.md CHANGED Viewed

@@ -8,6 +8,8 @@ This project is designed to be improved until it's ready for use in complex prod
 This is an educational project that was started as part of the [Understanding Node.js: Core Concepts](https://www.udemy.com/course/understanding-nodejs-core-concepts/?referralCode=0BC21AC4DD6958AE6A95) course. If you want to learn how to build a framework like this, and get to a point where you can build things like this yourself, check out this course!
+<em>This is the current demo, and the development of the project will begin starting from **September 2025.**</em>
 ## Why Cpeak?
 - **Minimalism**: No unnecessary bloat, with zero dependencies. Just the core essentials you need to build fast and reliable applications.
@@ -24,13 +26,16 @@ This is an educational project that was started as part of the [Understanding No
   - [Initializing](#initializing)
   - [Middleware](#middleware)
   - [Route Handling](#route-handling)
+  - [Route Middleware](#route-middleware)
   - [URL Variables & Parameters](#url-variables--parameters)
   - [Sending Files](#sending-files)
+  - [Redirecting](#redirecting)
   - [Error Handling](#error-handling)
   - [Listening](#listening)
   - [Util Functions](#util-functions)
     - [serveStatic](#servestatic)
     - [parseJSON](#parsejson)
+    - [render](#render)
 - [Complete Example](#complete-example)
 - [Versioning Notice](#versioning-notice)
@@ -114,6 +119,40 @@ server.beforeEach((req, res, next) => {
 });
 ```
+### Route Middleware
+You can also add middleware functions for a particular route handler like this:
+```javascript
+const requireAuth = (req, res, next, handleErr) => {
+  // Check if user is logged in, if so then:
+  req.test = "this is a test value";
+  next();
+  // If user is not logged in:
+  return handleErr({ status: 401, message: "Unauthorized" });
+};
+server.route("get", "/profile", requireAuth, (req, res, handleErr) => {
+  console.log(req.test); // this is a test value
+});
+```
+You can add as many middleware functions as you want for a route:
+```javascript
+server.route(
+  "get",
+  "/profile",
+  requireAuth,
+  anotherFunction,
+  oneMore,
+  (req, res, handleErr) => {
+    // your logic
+  }
+);
+```
 ### Route Handling
 You can add new routes like this:
@@ -159,9 +198,17 @@ server.route("get", "/testing", (req, res) => {
 The file’s binary content will be in the HTTP response body content. Make sure you specify a correct path relative to your CWD (use the `path` module for better compatibility) and also the correct HTTP MIME type for that file.
+### Redirecting
+If you want to redirect to a new URL, you can simply do:
+```javascript
+res.redirect("https://whatever.com");
+```
 ### Error Handling
-If anywhere in your route functions you want to return an error, it's cleaner to pass it to the `handleErr` function like this:
+If anywhere in your route functions or route middleware functions you want to return an error, it's cleaner to pass it to the `handleErr` function like this:
 ```javascript
 server.route("get", "/api/document/:title", (req, res, handleErr) => {
@@ -210,6 +257,7 @@ The list of utility functions as of now:
 - serveStatic
 - parseJSON
+- render
 Including any one of them is done like this:
@@ -269,12 +317,50 @@ server.route("put", "/api/user", (req, res) => {
 });
 ```
+#### render
+With this function you can do server side rendering before sending a file to a client. This can be useful for dynamic customization and search engine optimization.
+First fire it up like this:
+```javascript
+server.beforeEach(render());
+```
+And then for rendering:
+```javascript
+server.route("get", "/", (req, res, next) => {
+  return res.render(
+    "./public/index.html",
+    {
+      title: "Page title",
+      name: "Allan",
+    },
+    "text/html"
+  );
+});
+```
+You can then inject the variables into your file in {{ variable_name }} like this:
+```HTML
+<html>
+    <head>
+        <title>{{ title }}</title>
+    </head>
+    <body>
+        <h1>{{ name }}</h1>
+    </body>
+</html>
+```
 ## Complete Example
 Here you can see all the features that Cpeak offers, in one small piece of code:
 ```javascript
-import cpeak, { serveStatic, parseJSON } from "cpeak";
+import cpeak, { serveStatic, parseJSON, render } from "cpeak";
 const server = new cpeak();
@@ -284,6 +370,8 @@ server.beforeEach(
   })
 );
+server.beforeEach(render());
 // For parsing JSON bodies
 server.beforeEach(parseJSON);
@@ -293,25 +381,56 @@ server.beforeEach((req, res, next) => {
   next();
 });
-// Adding route handlers
-server.route("get", "/api/document/:title", (req, res, handleErr) => {
-  // Reading URL variables
-  const title = req.vars.title;
+// A middleware function that can be specified to run before some particular routes
+const testRouteMiddleware = (req, res, next, handleErr) => {
+  req.whatever = "some calculated value maybe";
-  // Reading URL parameters (like /users?filter=active)
-  const filter = req.params.filter;
+  if (req.vars.test !== "something special") {
+    return handleErr({ status: 400, message: "an error message" });
+  }
-  // Reading JSON request body
-  const anything = req.body.anything;
+  next();
+};
-  // Handling errors
-  if (anything === "not-expected-thing")
-    return handleErr({ status: 400, message: "Invalid property." });
+// Adding route handlers
+server.route("get", "/", (req, res, next) => {
+  return res.render(
+    "<path-to-file-relative-to-cwd>",
+    {
+      test: "some testing value",
+      number: "2343242",
+    },
+    "<mime-type>"
+  );
+});
-  // Sending a JSON response
-  res.status(200).json({ message: "This is a test response" });
+server.route("get", "/old-url", testRouteMiddleware, (req, res, next) => {
+  return res.redirect("/new-url");
 });
+server.route(
+  "get",
+  "/api/document/:title",
+  testRouteMiddleware,
+  (req, res, handleErr) => {
+    // Reading URL variables
+    const title = req.vars.title;
+    // Reading URL parameters (like /users?filter=active)
+    const filter = req.params.filter;
+    // Reading JSON request body
+    const anything = req.body.anything;
+    // Handling errors
+    if (anything === "not-expected-thing")
+      return handleErr({ status: 400, message: "Invalid property." });
+    // Sending a JSON response
+    res.status(200).json({ message: "This is a test response" });
+  }
+);
 // Sending a file response
 server.route("get", "/file", (req, res) => {
   // Make sure to specify a correct path and MIME type...

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,42 @@
+import { IncomingMessage, ServerResponse } from 'node:http';
+type StringMap = Record<string, string>;
+interface CpeakRequest extends IncomingMessage {
+    params: StringMap;
+    vars?: StringMap;
+    body?: unknown;
+    [key: string]: any;
+}
+interface CpeakResponse extends ServerResponse {
+    sendFile: (path: string, mime: string) => Promise<void>;
+    status: (code: number) => CpeakResponse;
+    redirect: (location: string) => CpeakResponse;
+    json: (data: any) => void;
+    [key: string]: any;
+}
+type Next = (err?: any) => void;
+type HandleErr = (err: any) => void;
+type Middleware = (req: CpeakRequest, res: CpeakResponse, next: Next, handleErr?: HandleErr) => void;
+type Handler = (req: CpeakRequest, res: CpeakResponse, handleErr: HandleErr) => void | Promise<void>;
+declare const parseJSON: (req: CpeakRequest, res: CpeakResponse, next: Next) => void;
+declare const serveStatic: (folderPath: string, newMimeTypes?: StringMap) => (req: CpeakRequest, res: CpeakResponse, next: Next) => void | Promise<void>;
+declare const render: () => (req: CpeakRequest, res: CpeakResponse, next: Next) => void;
+declare class Cpeak {
+    #private;
+    private server;
+    private routes;
+    private middleware;
+    private _handleErr?;
+    constructor();
+    route(method: string, path: string, ...args: (Middleware | Handler)[]): void;
+    beforeEach(cb: Middleware): void;
+    handleErr(cb: (err: unknown, req: CpeakRequest, res: CpeakResponse) => void): void;
+    listen(port: number, cb?: () => void): void;
+    close(cb?: (err?: Error) => void): void;
+}
+export { Cpeak as default, parseJSON, render, serveStatic };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,261 @@
+// lib/index.ts
+import http from "http";
+import fs3 from "fs/promises";
+// lib/utils/parseJSON.ts
+var parseJSON = (req, res, next) => {
+  function isJSON(contentType = "") {
+    const [type] = contentType.split(";");
+    return type.trim().toLowerCase() === "application/json" || /\+json$/i.test(type.trim());
+  }
+  if (!isJSON(req.headers["content-type"])) return next();
+  let body = "";
+  req.on("data", (chunk) => {
+    body += chunk.toString("utf-8");
+  });
+  req.on("end", () => {
+    body = JSON.parse(body);
+    req.body = body;
+    return next();
+  });
+};
+// lib/utils/serveStatic.ts
+import fs from "fs";
+import path from "path";
+var MIME_TYPES = {
+  html: "text/html",
+  css: "text/css",
+  js: "application/javascript",
+  jpg: "image/jpeg",
+  jpeg: "image/jpeg",
+  png: "image/png",
+  svg: "image/svg+xml",
+  txt: "text/plain",
+  eot: "application/vnd.ms-fontobject",
+  otf: "font/otf",
+  ttf: "font/ttf",
+  woff: "font/woff",
+  woff2: "font/woff2"
+};
+var serveStatic = (folderPath, newMimeTypes) => {
+  if (newMimeTypes) {
+    Object.assign(MIME_TYPES, newMimeTypes);
+  }
+  function processFolder(folderPath2, parentFolder) {
+    const staticFiles = [];
+    const files = fs.readdirSync(folderPath2);
+    for (const file of files) {
+      const fullPath = path.join(folderPath2, file);
+      if (fs.statSync(fullPath).isDirectory()) {
+        const subfolderFiles = processFolder(fullPath, parentFolder);
+        staticFiles.push(...subfolderFiles);
+      } else {
+        const relativePath = path.relative(parentFolder, fullPath);
+        const fileExtension = path.extname(file).slice(1);
+        if (MIME_TYPES[fileExtension]) staticFiles.push("/" + relativePath);
+      }
+    }
+    return staticFiles;
+  }
+  const filesArrayToFilesMap = (filesArray) => {
+    const filesMap2 = {};
+    for (const file of filesArray) {
+      const fileExtension = path.extname(file).slice(1);
+      filesMap2[file] = {
+        path: folderPath + file,
+        mime: MIME_TYPES[fileExtension]
+      };
+    }
+    return filesMap2;
+  };
+  const filesMap = filesArrayToFilesMap(processFolder(folderPath, folderPath));
+  return function(req, res, next) {
+    const url = req.url;
+    if (typeof url !== "string") return next();
+    if (Object.prototype.hasOwnProperty.call(filesMap, url)) {
+      const fileRoute = filesMap[url];
+      return res.sendFile(fileRoute.path, fileRoute.mime);
+    }
+    next();
+  };
+};
+// lib/utils/render.ts
+import fs2 from "fs/promises";
+function renderTemplate(templateStr, data) {
+  let result = [];
+  let currentIndex = 0;
+  while (currentIndex < templateStr.length) {
+    const startIdx = templateStr.indexOf("{{", currentIndex);
+    if (startIdx === -1) {
+      result.push(templateStr.slice(currentIndex));
+      break;
+    }
+    result.push(templateStr.slice(currentIndex, startIdx));
+    const endIdx = templateStr.indexOf("}}", startIdx);
+    if (endIdx === -1) {
+      result.push(templateStr.slice(startIdx));
+      break;
+    }
+    const varName = templateStr.slice(startIdx + 2, endIdx).trim();
+    const replacement = data[varName] !== void 0 ? data[varName] : "";
+    result.push(replacement);
+    currentIndex = endIdx + 2;
+  }
+  return result.join("");
+}
+var render = () => {
+  return function(req, res, next) {
+    res.render = async (path2, data, mime) => {
+      let fileStr = await fs2.readFile(path2, "utf-8");
+      const finalStr = renderTemplate(fileStr, data);
+      res.setHeader("Content-Type", mime);
+      res.end(finalStr);
+    };
+    next();
+  };
+};
+// lib/index.ts
+var Cpeak = class {
+  server;
+  routes;
+  middleware;
+  _handleErr;
+  constructor() {
+    this.server = http.createServer();
+    this.routes = {};
+    this.middleware = [];
+    this.server.on("request", (req, res) => {
+      res.sendFile = async (path2, mime) => {
+        const fileHandle = await fs3.open(path2, "r");
+        const fileStream = fileHandle.createReadStream();
+        res.setHeader("Content-Type", mime);
+        fileStream.pipe(res);
+      };
+      res.status = (code) => {
+        res.statusCode = code;
+        return res;
+      };
+      res.redirect = (location) => {
+        res.writeHead(302, { Location: location });
+        res.end();
+        return res;
+      };
+      res.json = (data) => {
+        res.setHeader("Content-Type", "application/json");
+        res.end(JSON.stringify(data));
+      };
+      const urlWithoutParams = req.url?.split("?")[0];
+      const params = new URLSearchParams(req.url?.split("?")[1]);
+      req.params = Object.fromEntries(params.entries());
+      const runHandler = (req2, res2, middleware, cb, index) => {
+        if (index === middleware.length) {
+          try {
+            const handlerResult = cb(req2, res2, (error) => {
+              res2.setHeader("Connection", "close");
+              this._handleErr?.(error, req2, res2);
+            });
+            if (handlerResult && typeof handlerResult.then === "function") {
+              handlerResult.catch((error) => {
+                res2.setHeader("Connection", "close");
+                this._handleErr?.(error, req2, res2);
+              });
+            }
+            return handlerResult;
+          } catch (error) {
+            res2.setHeader("Connection", "close");
+            this._handleErr?.(error, req2, res2);
+          }
+        } else {
+          middleware[index](
+            req2,
+            res2,
+            // The next function
+            () => {
+              runHandler(req2, res2, middleware, cb, index + 1);
+            },
+            // Error handler for a route middleware
+            (error) => {
+              res2.setHeader("Connection", "close");
+              this._handleErr?.(error, req2, res2);
+            }
+          );
+        }
+      };
+      const runMiddleware = (req2, res2, middleware, index) => {
+        if (index === middleware.length) {
+          const routes = this.routes[req2.method?.toLowerCase() || ""];
+          if (routes && typeof routes[Symbol.iterator] === "function")
+            for (const route of routes) {
+              const match = urlWithoutParams?.match(route.regex);
+              if (match) {
+                const vars = this.#extractVars(route.path, match);
+                req2.vars = vars;
+                return runHandler(req2, res2, route.middleware, route.cb, 0);
+              }
+            }
+          return res2.status(404).json({ error: `Cannot ${req2.method} ${urlWithoutParams}` });
+        } else {
+          middleware[index](req2, res2, () => {
+            runMiddleware(req2, res2, middleware, index + 1);
+          });
+        }
+      };
+      runMiddleware(req, res, this.middleware, 0);
+    });
+  }
+  route(method, path2, ...args) {
+    if (!this.routes[method]) this.routes[method] = [];
+    const cb = args.pop();
+    if (!cb || typeof cb !== "function") {
+      throw new Error("Route definition must include a handler");
+    }
+    const middleware = args.flat();
+    const regex = this.#pathToRegex(path2);
+    this.routes[method].push({ path: path2, regex, middleware, cb });
+  }
+  beforeEach(cb) {
+    this.middleware.push(cb);
+  }
+  handleErr(cb) {
+    this._handleErr = cb;
+  }
+  listen(port, cb) {
+    this.server.listen(port, cb);
+  }
+  close(cb) {
+    this.server.close(cb);
+  }
+  // ------------------------------
+  // PRIVATE METHODS:
+  // ------------------------------
+  #pathToRegex(path2) {
+    const varNames = [];
+    const regexString = "^" + path2.replace(/:\w+/g, (match, offset) => {
+      varNames.push(match.slice(1));
+      return "([^/]+)";
+    }) + "$";
+    const regex = new RegExp(regexString);
+    return regex;
+  }
+  #extractVars(path2, match) {
+    const varNames = (path2.match(/:\w+/g) || []).map(
+      (varParam) => varParam.slice(1)
+    );
+    const vars = {};
+    varNames.forEach((name, index) => {
+      vars[name] = match[index + 1];
+    });
+    return vars;
+  }
+};
+var index_default = Cpeak;
+export {
+  index_default as default,
+  parseJSON,
+  render,
+  serveStatic
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../lib/index.ts","../lib/utils/parseJSON.ts","../lib/utils/serveStatic.ts","../lib/utils/render.ts"],"sourcesContent":["import http, { IncomingMessage, ServerResponse } from \"node:http\";\nimport fs from \"node:fs/promises\";\n\nimport { serveStatic, parseJSON, render } from \"./utils\";\n\nimport type {\n StringMap,\n CpeakRequest,\n CpeakResponse,\n Middleware,\n Handler,\n RoutesMap,\n} from \"./types\";\n\nclass Cpeak {\n private server: http.Server;\n private routes: RoutesMap;\n private middleware: Middleware[];\n private _handleErr?: (\n err: unknown,\n req: CpeakRequest,\n res: CpeakResponse\n ) => void;\n\n constructor() {\n this.server = http.createServer();\n this.routes = {};\n this.middleware = [];\n\n this.server.on(\"request\", (req: CpeakRequest, res: CpeakResponse) => {\n // Send a file back to the client\n res.sendFile = async (path: string, mime: string) => {\n const fileHandle = await fs.open(path, \"r\");\n const fileStream = fileHandle.createReadStream();\n\n res.setHeader(\"Content-Type\", mime);\n\n fileStream.pipe(res);\n };\n\n // Set the status code of the response\n res.status = (code: number) => {\n res.statusCode = code;\n return res;\n };\n\n // Redirects to a new URL\n res.redirect = (location: string) => {\n res.writeHead(302, { Location: location });\n res.end();\n return res;\n };\n\n // Send a json data back to the client (for small json data, less than the highWaterMark)\n res.json = (data: any) => {\n // This is only good for bodies that their size is less than the highWaterMark value\n res.setHeader(\"Content-Type\", \"application/json\");\n res.end(JSON.stringify(data));\n };\n\n // Get the url without the URL parameters\n const urlWithoutParams = req.url?.split(\"?\")[0];\n\n // Parse the URL parameters (like /users?key1=value1&key2=value2)\n // We put this here to also parse them for all the middleware functions\n const params = new URLSearchParams(req.url?.split(\"?\")[1]);\n req.params = Object.fromEntries(params.entries());\n\n // Run all the specific middleware functions for that router only and then run the handler\n const runHandler = (\n req: CpeakRequest,\n res: CpeakResponse,\n middleware: Middleware[],\n cb: Handler,\n index: number\n ) => {\n // Our exit point...\n if (index === middleware.length) {\n // Call the route handler with the modified req and res objects.\n // Also handle the promise errors by passing them to the handleErr to save developers from having to manually wrap every handler in try catch.\n try {\n const handlerResult = cb(req, res, (error) => {\n res.setHeader(\"Connection\", \"close\");\n this._handleErr?.(error, req, res);\n });\n\n if (handlerResult && typeof handlerResult.then === \"function\") {\n handlerResult.catch((error) => {\n res.setHeader(\"Connection\", \"close\");\n this._handleErr?.(error, req, res);\n });\n }\n\n return handlerResult;\n } catch (error) {\n res.setHeader(\"Connection\", \"close\");\n this._handleErr?.(error, req, res);\n }\n } else {\n middleware[index](\n req,\n res,\n // The next function\n () => {\n runHandler(req, res, middleware, cb, index + 1);\n },\n // Error handler for a route middleware\n (error) => {\n res.setHeader(\"Connection\", \"close\");\n this._handleErr?.(error, req, res);\n }\n );\n }\n };\n\n // Run all the middleware functions (beforeEach functions) before we run the corresponding route\n const runMiddleware = (\n req: CpeakRequest,\n res: CpeakResponse,\n middleware: Middleware[],\n index: number\n ) => {\n // Our exit point...\n if (index === middleware.length) {\n const routes = this.routes[req.method?.toLowerCase() || \"\"];\n if (routes && typeof routes[Symbol.iterator] === \"function\")\n for (const route of routes) {\n const match = urlWithoutParams?.match(route.regex);\n\n if (match) {\n // Parse the URL variables from the matched route (like /users/:id)\n const vars = this.#extractVars(route.path, match);\n req.vars = vars;\n\n return runHandler(req, res, route.middleware, route.cb, 0);\n }\n }\n\n // If the requested route dose not exist, return 404\n return res\n .status(404)\n .json({ error: `Cannot ${req.method} ${urlWithoutParams}` });\n } else {\n middleware[index](req, res, () => {\n runMiddleware(req, res, middleware, index + 1);\n });\n }\n };\n\n runMiddleware(req, res, this.middleware, 0);\n });\n }\n\n route(method: string, path: string, ...args: (Middleware | Handler)[]) {\n if (!this.routes[method]) this.routes[method] = [];\n\n // The last argument should always be our handler\n const cb = args.pop();\n\n if (!cb || typeof cb !== \"function\") {\n throw new Error(\"Route definition must include a handler\");\n }\n\n // Rest will be our middleware functions\n const middleware = args.flat() as Middleware[];\n\n const regex = this.#pathToRegex(path);\n this.routes[method].push({ path, regex, middleware, cb });\n }\n\n beforeEach(cb: Middleware) {\n this.middleware.push(cb);\n }\n\n handleErr(cb: (err: unknown, req: CpeakRequest, res: CpeakResponse) => void) {\n this._handleErr = cb;\n }\n\n listen(port: number, cb?: () => void) {\n this.server.listen(port, cb);\n }\n\n close(cb?: (err?: Error) => void) {\n this.server.close(cb);\n }\n\n // ------------------------------\n // PRIVATE METHODS:\n // ------------------------------\n #pathToRegex(path: string) {\n const varNames: string[] = [];\n const regexString =\n \"^\" +\n path.replace(/:\\w+/g, (match, offset) => {\n varNames.push(match.slice(1));\n return \"([^/]+)\";\n }) +\n \"$\";\n\n const regex = new RegExp(regexString);\n return regex;\n }\n\n #extractVars(path: string, match: RegExpMatchArray) {\n // Extract url variable values from the matched route\n const varNames = (path.match(/:\\w+/g) || []).map((varParam) =>\n varParam.slice(1)\n );\n const vars: StringMap = {};\n varNames.forEach((name, index) => {\n vars[name] = match[index + 1];\n });\n return vars;\n }\n}\n\nexport { serveStatic, parseJSON, render };\n\nexport default Cpeak;\n","import type { CpeakRequest, CpeakResponse, Next } from \"../types\";\n\n// Parsing JSON\nconst parseJSON = (req: CpeakRequest, res: CpeakResponse, next: Next) => {\n // This is only good for bodies that their size is less than the highWaterMark value\n\n function isJSON(contentType: string = \"\") {\n // Remove any params like \"; charset=UTF-8\"\n const [type] = contentType.split(\";\");\n return (\n type.trim().toLowerCase() === \"application/json\" ||\n /\\+json$/i.test(type.trim())\n );\n }\n\n if (!isJSON(req.headers[\"content-type\"] as string)) return next();\n\n let body = \"\";\n req.on(\"data\", (chunk: Buffer) => {\n body += chunk.toString(\"utf-8\");\n });\n\n req.on(\"end\", () => {\n body = JSON.parse(body);\n req.body = body;\n return next();\n });\n};\n\nexport { parseJSON };\n","import fs from \"node:fs\";\nimport path from \"node:path\";\n\nimport type { StringMap, CpeakRequest, CpeakResponse, Next } from \"../types.js\";\n\nconst MIME_TYPES: StringMap = {\n html: \"text/html\",\n css: \"text/css\",\n js: \"application/javascript\",\n jpg: \"image/jpeg\",\n jpeg: \"image/jpeg\",\n png: \"image/png\",\n svg: \"image/svg+xml\",\n txt: \"text/plain\",\n eot: \"application/vnd.ms-fontobject\",\n otf: \"font/otf\",\n ttf: \"font/ttf\",\n woff: \"font/woff\",\n woff2: \"font/woff2\",\n};\n\nconst serveStatic = (folderPath: string, newMimeTypes?: StringMap) => {\n // For new user defined mime types\n if (newMimeTypes) {\n Object.assign(MIME_TYPES, newMimeTypes);\n }\n\n function processFolder(folderPath: string, parentFolder: string) {\n const staticFiles: string[] = [];\n\n // Read the contents of the folder\n const files = fs.readdirSync(folderPath);\n\n // Loop through the files and subfolders\n for (const file of files) {\n const fullPath = path.join(folderPath, file);\n\n // Check if it's a directory\n if (fs.statSync(fullPath).isDirectory()) {\n // If it's a directory, recursively process it\n const subfolderFiles = processFolder(fullPath, parentFolder);\n staticFiles.push(...subfolderFiles);\n } else {\n // If it's a file, add it to the array\n const relativePath = path.relative(parentFolder, fullPath);\n const fileExtension = path.extname(file).slice(1);\n if (MIME_TYPES[fileExtension]) staticFiles.push(\"/\" + relativePath);\n }\n }\n\n return staticFiles;\n }\n\n const filesArrayToFilesMap = (filesArray: string[]) => {\n const filesMap: Record<string, { path: string; mime: string }> = {};\n for (const file of filesArray) {\n const fileExtension = path.extname(file).slice(1);\n filesMap[file] = {\n path: folderPath + file,\n mime: MIME_TYPES[fileExtension],\n };\n }\n return filesMap;\n };\n\n // Start processing the folder\n const filesMap = filesArrayToFilesMap(processFolder(folderPath, folderPath));\n\n return function (req: CpeakRequest, res: CpeakResponse, next: Next) {\n const url = req.url;\n if (typeof url !== \"string\") return next();\n\n if (Object.prototype.hasOwnProperty.call(filesMap, url)) {\n const fileRoute = filesMap[url];\n return res.sendFile(fileRoute.path, fileRoute.mime);\n }\n\n next();\n };\n};\n\nexport { serveStatic };\n","import fs from \"node:fs/promises\";\nimport type { CpeakRequest, CpeakResponse, Next } from \"../types.js\";\n\nfunction renderTemplate(\n templateStr: string,\n data: Record<string, unknown>\n): string {\n // Initialize variables\n let result: (string | unknown)[] = [];\n\n let currentIndex = 0;\n\n while (currentIndex < templateStr.length) {\n // Find the next opening placeholder\n const startIdx = templateStr.indexOf(\"{{\", currentIndex);\n if (startIdx === -1) {\n // No more placeholders, push the remaining string\n result.push(templateStr.slice(currentIndex));\n break;\n }\n\n // Push the part before the placeholder\n result.push(templateStr.slice(currentIndex, startIdx));\n\n // Find the closing placeholder\n const endIdx = templateStr.indexOf(\"}}\", startIdx);\n if (endIdx === -1) {\n // No closing brace found, treat the rest as plain text\n result.push(templateStr.slice(startIdx));\n break;\n }\n\n // Extract the variable name\n const varName = templateStr.slice(startIdx + 2, endIdx).trim();\n\n // Replace the variable with its value from the data, or use an empty string if not found\n const replacement = data[varName] !== undefined ? data[varName] : \"\";\n\n // Push the replacement to the result array\n result.push(replacement);\n\n // Move the index past the current closing placeholder\n currentIndex = endIdx + 2;\n }\n\n // Join all parts into a final string\n return result.join(\"\");\n}\n\n// Errors to return: recommend to not render files larger than 100KB\n// To Explore: Doing the operation in C++ and return the data as stream back to the client\n// @TODO: remove the file from static map\n// @TODO: escape the string to prevent XSS\n// @TODO: add another {{{ }}} option to not escape the string\nconst render = () => {\n return function (req: CpeakRequest, res: CpeakResponse, next: Next): void {\n res.render = async (\n path: string,\n data: Record<string, unknown>,\n mime: string\n ) => {\n let fileStr = await fs.readFile(path, \"utf-8\");\n const finalStr = renderTemplate(fileStr, data);\n res.setHeader(\"Content-Type\", mime);\n res.end(finalStr);\n };\n\n next();\n };\n};\n\nexport { render };\n"],"mappings":";AAAA,OAAO,UAA+C;AACtD,OAAOA,SAAQ;;;ACEf,IAAM,YAAY,CAAC,KAAmB,KAAoB,SAAe;AAGvE,WAAS,OAAO,cAAsB,IAAI;AAExC,UAAM,CAAC,IAAI,IAAI,YAAY,MAAM,GAAG;AACpC,WACE,KAAK,KAAK,EAAE,YAAY,MAAM,sBAC9B,WAAW,KAAK,KAAK,KAAK,CAAC;AAAA,EAE/B;AAEA,MAAI,CAAC,OAAO,IAAI,QAAQ,cAAc,CAAW,EAAG,QAAO,KAAK;AAEhE,MAAI,OAAO;AACX,MAAI,GAAG,QAAQ,CAAC,UAAkB;AAChC,YAAQ,MAAM,SAAS,OAAO;AAAA,EAChC,CAAC;AAED,MAAI,GAAG,OAAO,MAAM;AAClB,WAAO,KAAK,MAAM,IAAI;AACtB,QAAI,OAAO;AACX,WAAO,KAAK;AAAA,EACd,CAAC;AACH;;;AC3BA,OAAO,QAAQ;AACf,OAAO,UAAU;AAIjB,IAAM,aAAwB;AAAA,EAC5B,MAAM;AAAA,EACN,KAAK;AAAA,EACL,IAAI;AAAA,EACJ,KAAK;AAAA,EACL,MAAM;AAAA,EACN,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,KAAK;AAAA,EACL,MAAM;AAAA,EACN,OAAO;AACT;AAEA,IAAM,cAAc,CAAC,YAAoB,iBAA6B;AAEpE,MAAI,cAAc;AAChB,WAAO,OAAO,YAAY,YAAY;AAAA,EACxC;AAEA,WAAS,cAAcC,aAAoB,cAAsB;AAC/D,UAAM,cAAwB,CAAC;AAG/B,UAAM,QAAQ,GAAG,YAAYA,WAAU;AAGvC,eAAW,QAAQ,OAAO;AACxB,YAAM,WAAW,KAAK,KAAKA,aAAY,IAAI;AAG3C,UAAI,GAAG,SAAS,QAAQ,EAAE,YAAY,GAAG;AAEvC,cAAM,iBAAiB,cAAc,UAAU,YAAY;AAC3D,oBAAY,KAAK,GAAG,cAAc;AAAA,MACpC,OAAO;AAEL,cAAM,eAAe,KAAK,SAAS,cAAc,QAAQ;AACzD,cAAM,gBAAgB,KAAK,QAAQ,IAAI,EAAE,MAAM,CAAC;AAChD,YAAI,WAAW,aAAa,EAAG,aAAY,KAAK,MAAM,YAAY;AAAA,MACpE;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAEA,QAAM,uBAAuB,CAAC,eAAyB;AACrD,UAAMC,YAA2D,CAAC;AAClE,eAAW,QAAQ,YAAY;AAC7B,YAAM,gBAAgB,KAAK,QAAQ,IAAI,EAAE,MAAM,CAAC;AAChD,MAAAA,UAAS,IAAI,IAAI;AAAA,QACf,MAAM,aAAa;AAAA,QACnB,MAAM,WAAW,aAAa;AAAA,MAChC;AAAA,IACF;AACA,WAAOA;AAAA,EACT;AAGA,QAAM,WAAW,qBAAqB,cAAc,YAAY,UAAU,CAAC;AAE3E,SAAO,SAAU,KAAmB,KAAoB,MAAY;AAClE,UAAM,MAAM,IAAI;AAChB,QAAI,OAAO,QAAQ,SAAU,QAAO,KAAK;AAEzC,QAAI,OAAO,UAAU,eAAe,KAAK,UAAU,GAAG,GAAG;AACvD,YAAM,YAAY,SAAS,GAAG;AAC9B,aAAO,IAAI,SAAS,UAAU,MAAM,UAAU,IAAI;AAAA,IACpD;AAEA,SAAK;AAAA,EACP;AACF;;;AC/EA,OAAOC,SAAQ;AAGf,SAAS,eACP,aACA,MACQ;AAER,MAAI,SAA+B,CAAC;AAEpC,MAAI,eAAe;AAEnB,SAAO,eAAe,YAAY,QAAQ;AAExC,UAAM,WAAW,YAAY,QAAQ,MAAM,YAAY;AACvD,QAAI,aAAa,IAAI;AAEnB,aAAO,KAAK,YAAY,MAAM,YAAY,CAAC;AAC3C;AAAA,IACF;AAGA,WAAO,KAAK,YAAY,MAAM,cAAc,QAAQ,CAAC;AAGrD,UAAM,SAAS,YAAY,QAAQ,MAAM,QAAQ;AACjD,QAAI,WAAW,IAAI;AAEjB,aAAO,KAAK,YAAY,MAAM,QAAQ,CAAC;AACvC;AAAA,IACF;AAGA,UAAM,UAAU,YAAY,MAAM,WAAW,GAAG,MAAM,EAAE,KAAK;AAG7D,UAAM,cAAc,KAAK,OAAO,MAAM,SAAY,KAAK,OAAO,IAAI;AAGlE,WAAO,KAAK,WAAW;AAGvB,mBAAe,SAAS;AAAA,EAC1B;AAGA,SAAO,OAAO,KAAK,EAAE;AACvB;AAOA,IAAM,SAAS,MAAM;AACnB,SAAO,SAAU,KAAmB,KAAoB,MAAkB;AACxE,QAAI,SAAS,OACXC,OACA,MACA,SACG;AACH,UAAI,UAAU,MAAMD,IAAG,SAASC,OAAM,OAAO;AAC7C,YAAM,WAAW,eAAe,SAAS,IAAI;AAC7C,UAAI,UAAU,gBAAgB,IAAI;AAClC,UAAI,IAAI,QAAQ;AAAA,IAClB;AAEA,SAAK;AAAA,EACP;AACF;;;AHvDA,IAAM,QAAN,MAAY;AAAA,EACF;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAMR,cAAc;AACZ,SAAK,SAAS,KAAK,aAAa;AAChC,SAAK,SAAS,CAAC;AACf,SAAK,aAAa,CAAC;AAEnB,SAAK,OAAO,GAAG,WAAW,CAAC,KAAmB,QAAuB;AAEnE,UAAI,WAAW,OAAOC,OAAc,SAAiB;AACnD,cAAM,aAAa,MAAMC,IAAG,KAAKD,OAAM,GAAG;AAC1C,cAAM,aAAa,WAAW,iBAAiB;AAE/C,YAAI,UAAU,gBAAgB,IAAI;AAElC,mBAAW,KAAK,GAAG;AAAA,MACrB;AAGA,UAAI,SAAS,CAAC,SAAiB;AAC7B,YAAI,aAAa;AACjB,eAAO;AAAA,MACT;AAGA,UAAI,WAAW,CAAC,aAAqB;AACnC,YAAI,UAAU,KAAK,EAAE,UAAU,SAAS,CAAC;AACzC,YAAI,IAAI;AACR,eAAO;AAAA,MACT;AAGA,UAAI,OAAO,CAAC,SAAc;AAExB,YAAI,UAAU,gBAAgB,kBAAkB;AAChD,YAAI,IAAI,KAAK,UAAU,IAAI,CAAC;AAAA,MAC9B;AAGA,YAAM,mBAAmB,IAAI,KAAK,MAAM,GAAG,EAAE,CAAC;AAI9C,YAAM,SAAS,IAAI,gBAAgB,IAAI,KAAK,MAAM,GAAG,EAAE,CAAC,CAAC;AACzD,UAAI,SAAS,OAAO,YAAY,OAAO,QAAQ,CAAC;AAGhD,YAAM,aAAa,CACjBE,MACAC,MACA,YACA,IACA,UACG;AAEH,YAAI,UAAU,WAAW,QAAQ;AAG/B,cAAI;AACF,kBAAM,gBAAgB,GAAGD,MAAKC,MAAK,CAAC,UAAU;AAC5C,cAAAA,KAAI,UAAU,cAAc,OAAO;AACnC,mBAAK,aAAa,OAAOD,MAAKC,IAAG;AAAA,YACnC,CAAC;AAED,gBAAI,iBAAiB,OAAO,cAAc,SAAS,YAAY;AAC7D,4BAAc,MAAM,CAAC,UAAU;AAC7B,gBAAAA,KAAI,UAAU,cAAc,OAAO;AACnC,qBAAK,aAAa,OAAOD,MAAKC,IAAG;AAAA,cACnC,CAAC;AAAA,YACH;AAEA,mBAAO;AAAA,UACT,SAAS,OAAO;AACd,YAAAA,KAAI,UAAU,cAAc,OAAO;AACnC,iBAAK,aAAa,OAAOD,MAAKC,IAAG;AAAA,UACnC;AAAA,QACF,OAAO;AACL,qBAAW,KAAK;AAAA,YACdD;AAAA,YACAC;AAAA;AAAA,YAEA,MAAM;AACJ,yBAAWD,MAAKC,MAAK,YAAY,IAAI,QAAQ,CAAC;AAAA,YAChD;AAAA;AAAA,YAEA,CAAC,UAAU;AACT,cAAAA,KAAI,UAAU,cAAc,OAAO;AACnC,mBAAK,aAAa,OAAOD,MAAKC,IAAG;AAAA,YACnC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAGA,YAAM,gBAAgB,CACpBD,MACAC,MACA,YACA,UACG;AAEH,YAAI,UAAU,WAAW,QAAQ;AAC/B,gBAAM,SAAS,KAAK,OAAOD,KAAI,QAAQ,YAAY,KAAK,EAAE;AAC1D,cAAI,UAAU,OAAO,OAAO,OAAO,QAAQ,MAAM;AAC/C,uBAAW,SAAS,QAAQ;AAC1B,oBAAM,QAAQ,kBAAkB,MAAM,MAAM,KAAK;AAEjD,kBAAI,OAAO;AAET,sBAAM,OAAO,KAAK,aAAa,MAAM,MAAM,KAAK;AAChD,gBAAAA,KAAI,OAAO;AAEX,uBAAO,WAAWA,MAAKC,MAAK,MAAM,YAAY,MAAM,IAAI,CAAC;AAAA,cAC3D;AAAA,YACF;AAGF,iBAAOA,KACJ,OAAO,GAAG,EACV,KAAK,EAAE,OAAO,UAAUD,KAAI,MAAM,IAAI,gBAAgB,GAAG,CAAC;AAAA,QAC/D,OAAO;AACL,qBAAW,KAAK,EAAEA,MAAKC,MAAK,MAAM;AAChC,0BAAcD,MAAKC,MAAK,YAAY,QAAQ,CAAC;AAAA,UAC/C,CAAC;AAAA,QACH;AAAA,MACF;AAEA,oBAAc,KAAK,KAAK,KAAK,YAAY,CAAC;AAAA,IAC5C,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,QAAgBH,UAAiB,MAAgC;AACrE,QAAI,CAAC,KAAK,OAAO,MAAM,EAAG,MAAK,OAAO,MAAM,IAAI,CAAC;AAGjD,UAAM,KAAK,KAAK,IAAI;AAEpB,QAAI,CAAC,MAAM,OAAO,OAAO,YAAY;AACnC,YAAM,IAAI,MAAM,yCAAyC;AAAA,IAC3D;AAGA,UAAM,aAAa,KAAK,KAAK;AAE7B,UAAM,QAAQ,KAAK,aAAaA,KAAI;AACpC,SAAK,OAAO,MAAM,EAAE,KAAK,EAAE,MAAAA,OAAM,OAAO,YAAY,GAAG,CAAC;AAAA,EAC1D;AAAA,EAEA,WAAW,IAAgB;AACzB,SAAK,WAAW,KAAK,EAAE;AAAA,EACzB;AAAA,EAEA,UAAU,IAAmE;AAC3E,SAAK,aAAa;AAAA,EACpB;AAAA,EAEA,OAAO,MAAc,IAAiB;AACpC,SAAK,OAAO,OAAO,MAAM,EAAE;AAAA,EAC7B;AAAA,EAEA,MAAM,IAA4B;AAChC,SAAK,OAAO,MAAM,EAAE;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA,EAKA,aAAaA,OAAc;AACzB,UAAM,WAAqB,CAAC;AAC5B,UAAM,cACJ,MACAA,MAAK,QAAQ,SAAS,CAAC,OAAO,WAAW;AACvC,eAAS,KAAK,MAAM,MAAM,CAAC,CAAC;AAC5B,aAAO;AAAA,IACT,CAAC,IACD;AAEF,UAAM,QAAQ,IAAI,OAAO,WAAW;AACpC,WAAO;AAAA,EACT;AAAA,EAEA,aAAaA,OAAc,OAAyB;AAElD,UAAM,YAAYA,MAAK,MAAM,OAAO,KAAK,CAAC,GAAG;AAAA,MAAI,CAAC,aAChD,SAAS,MAAM,CAAC;AAAA,IAClB;AACA,UAAM,OAAkB,CAAC;AACzB,aAAS,QAAQ,CAAC,MAAM,UAAU;AAChC,WAAK,IAAI,IAAI,MAAM,QAAQ,CAAC;AAAA,IAC9B,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAIA,IAAO,gBAAQ;","names":["fs","folderPath","filesMap","fs","path","path","fs","req","res"]}

package/lib/index.ts ADDED Viewed

@@ -0,0 +1,219 @@
+import http, { IncomingMessage, ServerResponse } from "node:http";
+import fs from "node:fs/promises";
+import { serveStatic, parseJSON, render } from "./utils";
+import type {
+  StringMap,
+  CpeakRequest,
+  CpeakResponse,
+  Middleware,
+  Handler,
+  RoutesMap,
+} from "./types";
+class Cpeak {
+  private server: http.Server;
+  private routes: RoutesMap;
+  private middleware: Middleware[];
+  private _handleErr?: (
+    err: unknown,
+    req: CpeakRequest,
+    res: CpeakResponse
+  ) => void;
+  constructor() {
+    this.server = http.createServer();
+    this.routes = {};
+    this.middleware = [];
+    this.server.on("request", (req: CpeakRequest, res: CpeakResponse) => {
+      // Send a file back to the client
+      res.sendFile = async (path: string, mime: string) => {
+        const fileHandle = await fs.open(path, "r");
+        const fileStream = fileHandle.createReadStream();
+        res.setHeader("Content-Type", mime);
+        fileStream.pipe(res);
+      };
+      // Set the status code of the response
+      res.status = (code: number) => {
+        res.statusCode = code;
+        return res;
+      };
+      // Redirects to a new URL
+      res.redirect = (location: string) => {
+        res.writeHead(302, { Location: location });
+        res.end();
+        return res;
+      };
+      // Send a json data back to the client (for small json data, less than the highWaterMark)
+      res.json = (data: any) => {
+        // This is only good for bodies that their size is less than the highWaterMark value
+        res.setHeader("Content-Type", "application/json");
+        res.end(JSON.stringify(data));
+      };
+      // Get the url without the URL parameters
+      const urlWithoutParams = req.url?.split("?")[0];
+      // Parse the URL parameters (like /users?key1=value1&key2=value2)
+      // We put this here to also parse them for all the middleware functions
+      const params = new URLSearchParams(req.url?.split("?")[1]);
+      req.params = Object.fromEntries(params.entries());
+      // Run all the specific middleware functions for that router only and then run the handler
+      const runHandler = (
+        req: CpeakRequest,
+        res: CpeakResponse,
+        middleware: Middleware[],
+        cb: Handler,
+        index: number
+      ) => {
+        // Our exit point...
+        if (index === middleware.length) {
+          // Call the route handler with the modified req and res objects.
+          // Also handle the promise errors by passing them to the handleErr to save developers from having to manually wrap every handler in try catch.
+          try {
+            const handlerResult = cb(req, res, (error) => {
+              res.setHeader("Connection", "close");
+              this._handleErr?.(error, req, res);
+            });
+            if (handlerResult && typeof handlerResult.then === "function") {
+              handlerResult.catch((error) => {
+                res.setHeader("Connection", "close");
+                this._handleErr?.(error, req, res);
+              });
+            }
+            return handlerResult;
+          } catch (error) {
+            res.setHeader("Connection", "close");
+            this._handleErr?.(error, req, res);
+          }
+        } else {
+          middleware[index](
+            req,
+            res,
+            // The next function
+            () => {
+              runHandler(req, res, middleware, cb, index + 1);
+            },
+            // Error handler for a route middleware
+            (error) => {
+              res.setHeader("Connection", "close");
+              this._handleErr?.(error, req, res);
+            }
+          );
+        }
+      };
+      // Run all the middleware functions (beforeEach functions) before we run the corresponding route
+      const runMiddleware = (
+        req: CpeakRequest,
+        res: CpeakResponse,
+        middleware: Middleware[],
+        index: number
+      ) => {
+        // Our exit point...
+        if (index === middleware.length) {
+          const routes = this.routes[req.method?.toLowerCase() || ""];
+          if (routes && typeof routes[Symbol.iterator] === "function")
+            for (const route of routes) {
+              const match = urlWithoutParams?.match(route.regex);
+              if (match) {
+                // Parse the URL variables from the matched route (like /users/:id)
+                const vars = this.#extractVars(route.path, match);
+                req.vars = vars;
+                return runHandler(req, res, route.middleware, route.cb, 0);
+              }
+            }
+          // If the requested route dose not exist, return 404
+          return res
+            .status(404)
+            .json({ error: `Cannot ${req.method} ${urlWithoutParams}` });
+        } else {
+          middleware[index](req, res, () => {
+            runMiddleware(req, res, middleware, index + 1);
+          });
+        }
+      };
+      runMiddleware(req, res, this.middleware, 0);
+    });
+  }
+  route(method: string, path: string, ...args: (Middleware | Handler)[]) {
+    if (!this.routes[method]) this.routes[method] = [];
+    // The last argument should always be our handler
+    const cb = args.pop();
+    if (!cb || typeof cb !== "function") {
+      throw new Error("Route definition must include a handler");
+    }
+    // Rest will be our middleware functions
+    const middleware = args.flat() as Middleware[];
+    const regex = this.#pathToRegex(path);
+    this.routes[method].push({ path, regex, middleware, cb });
+  }
+  beforeEach(cb: Middleware) {
+    this.middleware.push(cb);
+  }
+  handleErr(cb: (err: unknown, req: CpeakRequest, res: CpeakResponse) => void) {
+    this._handleErr = cb;
+  }
+  listen(port: number, cb?: () => void) {
+    this.server.listen(port, cb);
+  }
+  close(cb?: (err?: Error) => void) {
+    this.server.close(cb);
+  }
+  // ------------------------------
+  // PRIVATE METHODS:
+  // ------------------------------
+  #pathToRegex(path: string) {
+    const varNames: string[] = [];
+    const regexString =
+      "^" +
+      path.replace(/:\w+/g, (match, offset) => {
+        varNames.push(match.slice(1));
+        return "([^/]+)";
+      }) +
+      "$";
+    const regex = new RegExp(regexString);
+    return regex;
+  }
+  #extractVars(path: string, match: RegExpMatchArray) {
+    // Extract url variable values from the matched route
+    const varNames = (path.match(/:\w+/g) || []).map((varParam) =>
+      varParam.slice(1)
+    );
+    const vars: StringMap = {};
+    varNames.forEach((name, index) => {
+      vars[name] = match[index + 1];
+    });
+    return vars;
+  }
+}
+export { serveStatic, parseJSON, render };
+export default Cpeak;

package/lib/types.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import { IncomingMessage, ServerResponse } from "node:http";
+// Extending Node.js's Request and Response objects to add our custom properties
+export type StringMap = Record<string, string>;
+export interface CpeakRequest extends IncomingMessage {
+  params: StringMap;
+  vars?: StringMap;
+  body?: unknown;
+  [key: string]: any; // allow developers to add their onw extensions (e.g. req.test)
+}
+export interface CpeakResponse extends ServerResponse {
+  sendFile: (path: string, mime: string) => Promise<void>;
+  status: (code: number) => CpeakResponse;
+  redirect: (location: string) => CpeakResponse;
+  json: (data: any) => void;
+  [key: string]: any; // allow developers to add their onw extensions (e.g. res.test)
+}
+export type Next = (err?: any) => void;
+export type HandleErr = (err: any) => void;
+// beforeEach middleware: (req, res, next)
+// Route middleware:      (req, res, next, handleErr)
+export type Middleware = (
+  req: CpeakRequest,
+  res: CpeakResponse,
+  next: Next,
+  handleErr?: HandleErr
+) => void;
+// Route handlers: (req, res, handleErr)
+export type Handler = (
+  req: CpeakRequest,
+  res: CpeakResponse,
+  handleErr: HandleErr
+) => void | Promise<void>;
+// For a route object value in Cpeak.routes. The key is the method name.
+export interface Route {
+  path: string;
+  regex: RegExp;
+  middleware: Middleware[];
+  cb: Handler;
+}
+// For Cpeak.routes:
+export interface RoutesMap {
+  [method: string]: Route[];
+}

package/lib/utils/index.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { parseJSON } from "./parseJSON";
+import { serveStatic } from "./serveStatic";
+import { render } from "./render";
+export { serveStatic, parseJSON, render };

package/lib/utils/parseJSON.ts ADDED Viewed

@@ -0,0 +1,30 @@
+import type { CpeakRequest, CpeakResponse, Next } from "../types";
+// Parsing JSON
+const parseJSON = (req: CpeakRequest, res: CpeakResponse, next: Next) => {
+  // This is only good for bodies that their size is less than the highWaterMark value
+  function isJSON(contentType: string = "") {
+    // Remove any params like "; charset=UTF-8"
+    const [type] = contentType.split(";");
+    return (
+      type.trim().toLowerCase() === "application/json" ||
+      /\+json$/i.test(type.trim())
+    );
+  }
+  if (!isJSON(req.headers["content-type"] as string)) return next();
+  let body = "";
+  req.on("data", (chunk: Buffer) => {
+    body += chunk.toString("utf-8");
+  });
+  req.on("end", () => {
+    body = JSON.parse(body);
+    req.body = body;
+    return next();
+  });
+};
+export { parseJSON };

package/lib/utils/render.ts ADDED Viewed

@@ -0,0 +1,72 @@
+import fs from "node:fs/promises";
+import type { CpeakRequest, CpeakResponse, Next } from "../types.js";
+function renderTemplate(
+  templateStr: string,
+  data: Record<string, unknown>
+): string {
+  // Initialize variables
+  let result: (string | unknown)[] = [];
+  let currentIndex = 0;
+  while (currentIndex < templateStr.length) {
+    // Find the next opening placeholder
+    const startIdx = templateStr.indexOf("{{", currentIndex);
+    if (startIdx === -1) {
+      // No more placeholders, push the remaining string
+      result.push(templateStr.slice(currentIndex));
+      break;
+    }
+    // Push the part before the placeholder
+    result.push(templateStr.slice(currentIndex, startIdx));
+    // Find the closing placeholder
+    const endIdx = templateStr.indexOf("}}", startIdx);
+    if (endIdx === -1) {
+      // No closing brace found, treat the rest as plain text
+      result.push(templateStr.slice(startIdx));
+      break;
+    }
+    // Extract the variable name
+    const varName = templateStr.slice(startIdx + 2, endIdx).trim();
+    // Replace the variable with its value from the data, or use an empty string if not found
+    const replacement = data[varName] !== undefined ? data[varName] : "";
+    // Push the replacement to the result array
+    result.push(replacement);
+    // Move the index past the current closing placeholder
+    currentIndex = endIdx + 2;
+  }
+  // Join all parts into a final string
+  return result.join("");
+}
+// Errors to return: recommend to not render files larger than 100KB
+// To Explore: Doing the operation in C++ and return the data as stream back to the client
+// @TODO: remove the file from static map
+// @TODO: escape the string to prevent XSS
+// @TODO: add another {{{ }}} option to not escape the string
+const render = () => {
+  return function (req: CpeakRequest, res: CpeakResponse, next: Next): void {
+    res.render = async (
+      path: string,
+      data: Record<string, unknown>,
+      mime: string
+    ) => {
+      let fileStr = await fs.readFile(path, "utf-8");
+      const finalStr = renderTemplate(fileStr, data);
+      res.setHeader("Content-Type", mime);
+      res.end(finalStr);
+    };
+    next();
+  };
+};
+export { render };

package/lib/utils/{serveStatic.js → serveStatic.ts} RENAMED Viewed

@@ -1,7 +1,9 @@
 import fs from "node:fs";
 import path from "node:path";
-const MIME_TYPES = {
+import type { StringMap, CpeakRequest, CpeakResponse, Next } from "../types.js";
+const MIME_TYPES: StringMap = {
   html: "text/html",
   css: "text/css",
   js: "application/javascript",
@@ -17,14 +19,14 @@ const MIME_TYPES = {
   woff2: "font/woff2",
 };
-const serveStatic = (folderPath, newMimeTypes) => {
+const serveStatic = (folderPath: string, newMimeTypes?: StringMap) => {
   // For new user defined mime types
   if (newMimeTypes) {
     Object.assign(MIME_TYPES, newMimeTypes);
   }
-  function processFolder(folderPath, parentFolder) {
-    const staticFiles = [];
+  function processFolder(folderPath: string, parentFolder: string) {
+    const staticFiles: string[] = [];
     // Read the contents of the folder
     const files = fs.readdirSync(folderPath);
@@ -49,8 +51,8 @@ const serveStatic = (folderPath, newMimeTypes) => {
     return staticFiles;
   }
-  const filesArrayToFilesMap = (filesArray) => {
-    const filesMap = {};
+  const filesArrayToFilesMap = (filesArray: string[]) => {
+    const filesMap: Record<string, { path: string; mime: string }> = {};
     for (const file of filesArray) {
       const fileExtension = path.extname(file).slice(1);
       filesMap[file] = {
@@ -64,13 +66,16 @@ const serveStatic = (folderPath, newMimeTypes) => {
   // Start processing the folder
   const filesMap = filesArrayToFilesMap(processFolder(folderPath, folderPath));
-  return function (req, res, next) {
-    if (filesMap.hasOwnProperty(req.url)) {
-      const fileRoute = filesMap[req.url];
+  return function (req: CpeakRequest, res: CpeakResponse, next: Next) {
+    const url = req.url;
+    if (typeof url !== "string") return next();
+    if (Object.prototype.hasOwnProperty.call(filesMap, url)) {
+      const fileRoute = filesMap[url];
       return res.sendFile(fileRoute.path, fileRoute.mime);
-    } else {
-      next();
     }
+    next();
   };
 };

package/package.json CHANGED Viewed

@@ -1,11 +1,12 @@
 {
   "name": "cpeak",
-  "version": "2.2.5",
+  "version": "2.4.0",
   "description": "A minimal and fast Node.js HTTP framework.",
   "type": "module",
-  "main": "./lib/index.js",
   "scripts": {
-    "test": "mocha test/**/*.js"
+    "build": "tsup lib/index.ts --format esm --dts --sourcemap --out-dir dist --clean",
+    "dev": "tsup lib/index.ts --watch --format esm --dts --sourcemap --out-dir dist",
+    "test": "tsx ./node_modules/mocha/bin/_mocha --extension ts \"test/**/*.test.ts\""
   },
   "repository": {
     "type": "git",
@@ -15,6 +16,15 @@
     "url": "https://github.com/agile8118/cpeak/issues"
   },
   "homepage": "https://github.com/agile8118/cpeak#readme",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
   "author": "Cododev Technology",
   "license": "MIT",
   "keywords": [
@@ -26,7 +36,14 @@
     "framework"
   ],
   "devDependencies": {
-    "mocha": "^10.7.3",
-    "supertest": "^7.0.0"
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.3.0",
+    "@types/supertest": "^6.0.3",
+    "mocha": "^10.8.2",
+    "supertest": "^7.1.4",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.0",
+    "tsx": "^4.20.5",
+    "typescript": "^5.9.2"
   }
 }

package/lib/index.js DELETED Viewed

@@ -1,137 +0,0 @@
-import http from "node:http";
-import fs from "node:fs/promises";
-import { serveStatic, parseJSON } from "./utils/index.js";
-class Cpeak {
-  constructor() {
-    this.server = http.createServer();
-    this.routes = {};
-    this.middleware = [];
-    this.handleErr;
-    this.server.on("request", (req, res) => {
-      // Send a file back to the client
-      res.sendFile = async (path, mime) => {
-        const fileHandle = await fs.open(path, "r");
-        const fileStream = fileHandle.createReadStream();
-        res.setHeader("Content-Type", mime);
-        fileStream.pipe(res);
-      };
-      // Set the status code of the response
-      res.status = (code) => {
-        res.statusCode = code;
-        return res;
-      };
-      // Send a json data back to the client (for small json data, less than the highWaterMark)
-      res.json = (data) => {
-        // This is only good for bodies that their size is less than the highWaterMark value
-        res.setHeader("Content-Type", "application/json");
-        res.end(JSON.stringify(data));
-      };
-      // Get the url without the URL parameters
-      const urlWithoutParams = req.url.split("?")[0];
-      // Parse the URL parameters (like /users?key1=value1&key2=value2)
-      // We put this here to also parse them for all the middleware functions
-      const params = new URLSearchParams(req.url.split("?")[1]);
-      req.params = Object.fromEntries(params.entries());
-      // Run all the middleware functions before we run the corresponding route
-      const runMiddleware = (req, res, middleware, index) => {
-        // Out exit point...
-        if (index === middleware.length) {
-          const routes = this.routes[req.method.toLowerCase()];
-          if (routes && typeof routes[Symbol.iterator] === "function")
-            for (const route of routes) {
-              const match = urlWithoutParams.match(route.regex);
-              if (match) {
-                // Parse the URL variables from the matched route (like /users/:id)
-                const vars = this.#extractVars(route.path, match);
-                req.vars = vars;
-                // Call the route handler with the modified req and res objects
-                return route.cb(req, res, (error) => {
-                  res.setHeader("Connection", "close");
-                  this.handleErr(error, req, res);
-                });
-              }
-            }
-          // If the requested route dose not exist, return 404
-          return res
-            .status(404)
-            .json({ error: `Cannot ${req.method} ${urlWithoutParams}` });
-        } else {
-          middleware[index](req, res, () => {
-            runMiddleware(req, res, middleware, index + 1);
-          });
-        }
-      };
-      runMiddleware(req, res, this.middleware, 0);
-    });
-  }
-  route(method, path, cb) {
-    if (!this.routes[method]) this.routes[method] = [];
-    const regex = this.#pathToRegex(path);
-    this.routes[method].push({ path, regex, cb });
-  }
-  beforeEach(cb) {
-    this.middleware.push(cb);
-  }
-  handleErr(cb) {
-    this.handleErr = cb;
-  }
-  listen(port, cb) {
-    this.server.listen(port, cb);
-  }
-  close(cb) {
-    this.server.close(cb);
-  }
-  // ------------------------------
-  // PRIVATE METHODS:
-  // ------------------------------
-  #pathToRegex(path) {
-    const varNames = [];
-    const regexString =
-      "^" +
-      path.replace(/:\w+/g, (match, offset) => {
-        varNames.push(match.slice(1));
-        return "([^/]+)";
-      }) +
-      "$";
-    const regex = new RegExp(regexString);
-    return regex;
-  }
-  #extractVars(path, match) {
-    // Extract url variable values from the matched route
-    const varNames = (path.match(/:\w+/g) || []).map((varParam) =>
-      varParam.slice(1)
-    );
-    const vars = {};
-    varNames.forEach((name, index) => {
-      vars[name] = match[index + 1];
-    });
-    return vars;
-  }
-}
-export { serveStatic, parseJSON };
-export default Cpeak;

package/lib/utils/index.js DELETED Viewed

@@ -1,4 +0,0 @@
-import { parseJSON } from "./parseJSON.js";
-import { serveStatic } from "./serveStatic.js";
-export { serveStatic, parseJSON };

package/lib/utils/parseJSON.js DELETED Viewed

@@ -1,20 +0,0 @@
-// Parsing JSON
-const parseJSON = (req, res, next) => {
-  // This is only good for bodies that their size is less than the highWaterMark value
-  if (req.headers["content-type"] === "application/json") {
-    let body = "";
-    req.on("data", (chunk) => {
-      body += chunk.toString("utf-8");
-    });
-    req.on("end", () => {
-      body = JSON.parse(body);
-      req.body = body;
-      return next();
-    });
-  } else {
-    next();
-  }
-};
-export { parseJSON };