cpeak 2.3.0 → 2.4.1

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import http, { IncomingMessage, ServerResponse } from 'node:http';
+
+type Cpeak$1 = InstanceType<typeof Cpeak>;
+type StringMap = Record<string, string>;
+interface CpeakRequest<ReqBody = any, ReqParams = any> extends IncomingMessage {
+    params: ReqParams;
+    vars?: StringMap;
+    body?: ReqBody;
+    [key: string]: any;
+    query: ReqParams;
+}
+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<ReqBody = any, ReqParams = any> = (req: CpeakRequest<ReqBody, ReqParams>, res: CpeakResponse, next: Next) => void;
+type RouteMiddleware<ReqBody = any, ReqParams = any> = (req: CpeakRequest<ReqBody, ReqParams>, res: CpeakResponse, next: Next, handleErr: HandleErr) => void | Promise<void>;
+type Handler<ReqBody = any, ReqParams = any> = (req: CpeakRequest<ReqBody, ReqParams>, res: CpeakResponse, handleErr: HandleErr) => void | Promise<void>;
+interface Route {
+    path: string;
+    regex: RegExp;
+    middleware: RouteMiddleware[];
+    cb: Handler;
+}
+interface RoutesMap {
+    [method: string]: Route[];
+}
+
+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 function frameworkError(message: string, skipFn: Function, code?: string): Error & {
+    code?: string;
+};
+declare enum ErrorCode {
+    MISSING_MIME = "CPEAK_ERR_MISSING_MIME",
+    FILE_NOT_FOUND = "CPEAK_ERR_FILE_NOT_FOUND",
+    NOT_A_FILE = "CPEAK_ERR_NOT_A_FILE",
+    SEND_FILE_FAIL = "CPEAK_ERR_SEND_FILE_FAIL"
+}
+declare class Cpeak {
+    #private;
+    private server;
+    private routes;
+    private middleware;
+    private _handleErr?;
+    constructor();
+    route(method: string, path: string, ...args: (RouteMiddleware | Handler)[]): void;
+    beforeEach(cb: Middleware): void;
+    handleErr(cb: (err: unknown, req: CpeakRequest, res: CpeakResponse) => void): void;
+    listen(port: number, cb?: () => void): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    close(cb?: (err?: Error) => void): void;
+}
+
+export { type Cpeak$1 as Cpeak, type CpeakRequest, type CpeakResponse, ErrorCode, type HandleErr, type Handler, type Middleware, type Next, type RouteMiddleware, type RoutesMap, Cpeak as default, frameworkError, parseJSON, render, serveStatic };

package/dist/index.js

@@ -0,0 +1,319 @@
+// lib/index.ts
+import http from "http";
+import fs3 from "fs/promises";
+import { createReadStream } from "fs";
+import { pipeline } from "stream/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) => {
+      if (!mime) {
+        throw frameworkError(
+          `MIME type is missing. You called res.render("${path2}", ...) but forgot to provide the third "mime" argument.`,
+          res.render
+        );
+      }
+      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
+function frameworkError(message, skipFn, code) {
+  const err = new Error(message);
+  Error.captureStackTrace(err, skipFn);
+  if (code) err.code = code;
+  return err;
+}
+var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
+  ErrorCode2["MISSING_MIME"] = "CPEAK_ERR_MISSING_MIME";
+  ErrorCode2["FILE_NOT_FOUND"] = "CPEAK_ERR_FILE_NOT_FOUND";
+  ErrorCode2["NOT_A_FILE"] = "CPEAK_ERR_NOT_A_FILE";
+  ErrorCode2["SEND_FILE_FAIL"] = "CPEAK_ERR_SEND_FILE_FAIL";
+  return ErrorCode2;
+})(ErrorCode || {});
+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) => {
+        if (!mime) {
+          throw frameworkError(
+            'MIME type is missing. Use res.sendFile(path, "mime-type").',
+            res.sendFile,
+            "CPEAK_ERR_MISSING_MIME" /* MISSING_MIME */
+          );
+        }
+        try {
+          const stat = await fs3.stat(path2);
+          if (!stat.isFile()) {
+            throw frameworkError(
+              `Not a file: ${path2}`,
+              res.sendFile,
+              "CPEAK_ERR_NOT_A_FILE" /* NOT_A_FILE */
+            );
+          }
+          res.setHeader("Content-Type", mime);
+          res.setHeader("Content-Length", String(stat.size));
+          await pipeline(createReadStream(path2), res);
+        } catch (err) {
+          if (err?.code === "ENOENT") {
+            throw frameworkError(
+              `File not found: ${path2}`,
+              res.sendFile,
+              "CPEAK_ERR_FILE_NOT_FOUND" /* FILE_NOT_FOUND */
+            );
+          }
+          throw frameworkError(
+            `Failed to send file: ${path2}`,
+            res.sendFile,
+            "CPEAK_ERR_SEND_FILE_FAIL" /* SEND_FILE_FAIL */
+          );
+        }
+      };
+      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]);
+      const paramsObject = Object.fromEntries(params.entries());
+      req.params = paramsObject;
+      req.query = paramsObject;
+      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
+            (error) => {
+              if (error) {
+                res2.setHeader("Connection", "close");
+                return this._handleErr?.(error, req2, res2);
+              }
+              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) {
+    return 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 {
+  ErrorCode,
+  index_default as default,
+  frameworkError,
+  parseJSON,
+  render,
+  serveStatic
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../lib/index.ts","../lib/utils/parseJSON.ts","../lib/utils/serveStatic.ts","../lib/utils/render.ts"],"sourcesContent":["import http from \"node:http\";\nimport fs from \"node:fs/promises\";\nimport { createReadStream } from \"node:fs\";\nimport { pipeline } from \"node:stream/promises\";\n\nimport { serveStatic, parseJSON, render } from \"./utils\";\n\nimport type {\n  StringMap,\n  CpeakRequest,\n  CpeakResponse,\n  Middleware,\n  RouteMiddleware,\n  Handler,\n  RoutesMap,\n} from \"./types\";\n\n// A utility function to create an error with a custom stack trace\nexport function frameworkError(\n  message: string,\n  skipFn: Function,\n  code?: string\n) {\n  const err = new Error(message) as Error & { code?: string };\n  Error.captureStackTrace(err, skipFn);\n\n  if (code) err.code = code;\n\n  return err;\n}\n\nexport enum ErrorCode {\n  MISSING_MIME = \"CPEAK_ERR_MISSING_MIME\",\n  FILE_NOT_FOUND = \"CPEAK_ERR_FILE_NOT_FOUND\",\n  NOT_A_FILE = \"CPEAK_ERR_NOT_A_FILE\",\n  SEND_FILE_FAIL = \"CPEAK_ERR_SEND_FILE_FAIL\",\n}\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        if (!mime) {\n          throw frameworkError(\n            'MIME type is missing. Use res.sendFile(path, \"mime-type\").',\n            res.sendFile,\n            ErrorCode.MISSING_MIME\n          );\n        }\n\n        try {\n          const stat = await fs.stat(path);\n          if (!stat.isFile()) {\n            throw frameworkError(\n              `Not a file: ${path}`,\n              res.sendFile,\n              ErrorCode.NOT_A_FILE\n            );\n          }\n\n          res.setHeader(\"Content-Type\", mime);\n          res.setHeader(\"Content-Length\", String(stat.size));\n\n          // Properly propagate stream errors and respect backpressure\n          await pipeline(createReadStream(path), res);\n        } catch (err: any) {\n          if (err?.code === \"ENOENT\") {\n            throw frameworkError(\n              `File not found: ${path}`,\n              res.sendFile,\n              ErrorCode.FILE_NOT_FOUND\n            );\n          }\n\n          throw frameworkError(\n            `Failed to send file: ${path}`,\n            res.sendFile,\n            ErrorCode.SEND_FILE_FAIL\n          );\n        }\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\n      const paramsObject = Object.fromEntries(params.entries());\n\n      req.params = paramsObject;\n      req.query = paramsObject; // only for compatibility with frameworks built for express\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: RouteMiddleware[],\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            (error) => {\n              // this function only accepts an error argument to be more compatible with NPM modules that are built for express\n              if (error) {\n                res.setHeader(\"Connection\", \"close\");\n                return this._handleErr?.(error, req, res);\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: (RouteMiddleware | Handler)[]) {\n    if (!this.routes[method]) this.routes[method] = [];\n\n    // The last argument should always be our handler\n    const cb = args.pop() as Handler;\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 RouteMiddleware[];\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    return 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\n// Util functions\nexport { serveStatic, parseJSON, render };\n\nexport type {\n  Cpeak,\n  CpeakRequest,\n  CpeakResponse,\n  Next,\n  HandleErr,\n  Middleware,\n  RouteMiddleware,\n  Handler,\n  RoutesMap,\n} from \"./types\";\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\";\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 { frameworkError } from \"../\";\nimport type { CpeakRequest, CpeakResponse, Next } from \"../types\";\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      // check if mime is specified, if not return an error\n      if (!mime) {\n        throw frameworkError(\n          `MIME type is missing. You called res.render(\"${path}\", ...) but forgot to provide the third \"mime\" argument.`,\n          res.render\n        );\n      }\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,UAAU;AACjB,OAAOA,SAAQ;AACf,SAAS,wBAAwB;AACjC,SAAS,gBAAgB;;;ACAzB,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;AAIf,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;AAEH,UAAI,CAAC,MAAM;AACT,cAAM;AAAA,UACJ,gDAAgDA,KAAI;AAAA,UACpD,IAAI;AAAA,QACN;AAAA,MACF;AAEA,UAAI,UAAU,MAAMC,IAAG,SAASD,OAAM,OAAO;AAC7C,YAAM,WAAW,eAAe,SAAS,IAAI;AAC7C,UAAI,UAAU,gBAAgB,IAAI;AAClC,UAAI,IAAI,QAAQ;AAAA,IAClB;AAEA,SAAK;AAAA,EACP;AACF;;;AH5DO,SAAS,eACd,SACA,QACA,MACA;AACA,QAAM,MAAM,IAAI,MAAM,OAAO;AAC7B,QAAM,kBAAkB,KAAK,MAAM;AAEnC,MAAI,KAAM,KAAI,OAAO;AAErB,SAAO;AACT;AAEO,IAAK,YAAL,kBAAKE,eAAL;AACL,EAAAA,WAAA,kBAAe;AACf,EAAAA,WAAA,oBAAiB;AACjB,EAAAA,WAAA,gBAAa;AACb,EAAAA,WAAA,oBAAiB;AAJP,SAAAA;AAAA,GAAA;AAOZ,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,YAAI,CAAC,MAAM;AACT,gBAAM;AAAA,YACJ;AAAA,YACA,IAAI;AAAA,YACJ;AAAA,UACF;AAAA,QACF;AAEA,YAAI;AACF,gBAAM,OAAO,MAAMC,IAAG,KAAKD,KAAI;AAC/B,cAAI,CAAC,KAAK,OAAO,GAAG;AAClB,kBAAM;AAAA,cACJ,eAAeA,KAAI;AAAA,cACnB,IAAI;AAAA,cACJ;AAAA,YACF;AAAA,UACF;AAEA,cAAI,UAAU,gBAAgB,IAAI;AAClC,cAAI,UAAU,kBAAkB,OAAO,KAAK,IAAI,CAAC;AAGjD,gBAAM,SAAS,iBAAiBA,KAAI,GAAG,GAAG;AAAA,QAC5C,SAAS,KAAU;AACjB,cAAI,KAAK,SAAS,UAAU;AAC1B,kBAAM;AAAA,cACJ,mBAAmBA,KAAI;AAAA,cACvB,IAAI;AAAA,cACJ;AAAA,YACF;AAAA,UACF;AAEA,gBAAM;AAAA,YACJ,wBAAwBA,KAAI;AAAA,YAC5B,IAAI;AAAA,YACJ;AAAA,UACF;AAAA,QACF;AAAA,MACF;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;AAEzD,YAAM,eAAe,OAAO,YAAY,OAAO,QAAQ,CAAC;AAExD,UAAI,SAAS;AACb,UAAI,QAAQ;AAGZ,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,CAAC,UAAU;AAET,kBAAI,OAAO;AACT,gBAAAA,KAAI,UAAU,cAAc,OAAO;AACnC,uBAAO,KAAK,aAAa,OAAOD,MAAKC,IAAG;AAAA,cAC1C;AACA,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,MAAqC;AAC1E,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,WAAO,KAAK,OAAO,OAAO,MAAM,EAAE;AAAA,EACpC;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;AAiBA,IAAO,gBAAQ;","names":["fs","folderPath","filesMap","fs","path","fs","ErrorCode","path","fs","req","res"]}

package/lib/index.ts

@@ -0,0 +1,297 @@
+import http from "node:http";
+import fs from "node:fs/promises";
+import { createReadStream } from "node:fs";
+import { pipeline } from "node:stream/promises";
+
+import { serveStatic, parseJSON, render } from "./utils";
+
+import type {
+  StringMap,
+  CpeakRequest,
+  CpeakResponse,
+  Middleware,
+  RouteMiddleware,
+  Handler,
+  RoutesMap,
+} from "./types";
+
+// A utility function to create an error with a custom stack trace
+export function frameworkError(
+  message: string,
+  skipFn: Function,
+  code?: string
+) {
+  const err = new Error(message) as Error & { code?: string };
+  Error.captureStackTrace(err, skipFn);
+
+  if (code) err.code = code;
+
+  return err;
+}
+
+export enum ErrorCode {
+  MISSING_MIME = "CPEAK_ERR_MISSING_MIME",
+  FILE_NOT_FOUND = "CPEAK_ERR_FILE_NOT_FOUND",
+  NOT_A_FILE = "CPEAK_ERR_NOT_A_FILE",
+  SEND_FILE_FAIL = "CPEAK_ERR_SEND_FILE_FAIL",
+}
+
+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) => {
+        if (!mime) {
+          throw frameworkError(
+            'MIME type is missing. Use res.sendFile(path, "mime-type").',
+            res.sendFile,
+            ErrorCode.MISSING_MIME
+          );
+        }
+
+        try {
+          const stat = await fs.stat(path);
+          if (!stat.isFile()) {
+            throw frameworkError(
+              `Not a file: ${path}`,
+              res.sendFile,
+              ErrorCode.NOT_A_FILE
+            );
+          }
+
+          res.setHeader("Content-Type", mime);
+          res.setHeader("Content-Length", String(stat.size));
+
+          // Properly propagate stream errors and respect backpressure
+          await pipeline(createReadStream(path), res);
+        } catch (err: any) {
+          if (err?.code === "ENOENT") {
+            throw frameworkError(
+              `File not found: ${path}`,
+              res.sendFile,
+              ErrorCode.FILE_NOT_FOUND
+            );
+          }
+
+          throw frameworkError(
+            `Failed to send file: ${path}`,
+            res.sendFile,
+            ErrorCode.SEND_FILE_FAIL
+          );
+        }
+      };
+
+      // 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]);
+
+      const paramsObject = Object.fromEntries(params.entries());
+
+      req.params = paramsObject;
+      req.query = paramsObject; // only for compatibility with frameworks built for express
+
+      // Run all the specific middleware functions for that router only and then run the handler
+      const runHandler = (
+        req: CpeakRequest,
+        res: CpeakResponse,
+        middleware: RouteMiddleware[],
+        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
+            (error) => {
+              // this function only accepts an error argument to be more compatible with NPM modules that are built for express
+              if (error) {
+                res.setHeader("Connection", "close");
+                return this._handleErr?.(error, req, res);
+              }
+              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: (RouteMiddleware | Handler)[]) {
+    if (!this.routes[method]) this.routes[method] = [];
+
+    // The last argument should always be our handler
+    const cb = args.pop() as Handler;
+
+    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 RouteMiddleware[];
+
+    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) {
+    return 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;
+  }
+}
+
+// Util functions
+export { serveStatic, parseJSON, render };
+
+export type {
+  Cpeak,
+  CpeakRequest,
+  CpeakResponse,
+  Next,
+  HandleErr,
+  Middleware,
+  RouteMiddleware,
+  Handler,
+  RoutesMap,
+} from "./types";
+
+export default Cpeak;

package/lib/types.ts

@@ -0,0 +1,64 @@
+import { IncomingMessage, ServerResponse } from "node:http";
+import CpeakClass from "./index";
+
+export type Cpeak = InstanceType<typeof CpeakClass>;
+
+// Extending Node.js's Request and Response objects to add our custom properties
+export type StringMap = Record<string, string>;
+
+export interface CpeakRequest<ReqBody = any, ReqParams = any>
+  extends IncomingMessage {
+  params: ReqParams;
+  vars?: StringMap;
+  body?: ReqBody;
+  [key: string]: any; // allow developers to add their onw extensions (e.g. req.test)
+
+  // For express frameworks compatibility:
+  query: ReqParams;
+}
+
+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)
+export type Middleware<ReqBody = any, ReqParams = any> = (
+  req: CpeakRequest<ReqBody, ReqParams>,
+  res: CpeakResponse,
+  next: Next
+) => void;
+
+// Route middleware:      (req, res, next, handleErr)
+export type RouteMiddleware<ReqBody = any, ReqParams = any> = (
+  req: CpeakRequest<ReqBody, ReqParams>,
+  res: CpeakResponse,
+  next: Next,
+  handleErr: HandleErr
+) => void | Promise<void>;
+
+// Route handlers: (req, res, handleErr)
+export type Handler<ReqBody = any, ReqParams = any> = (
+  req: CpeakRequest<ReqBody, ReqParams>,
+  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: RouteMiddleware[];
+  cb: Handler;
+}
+
+// For Cpeak.routes:
+export interface RoutesMap {
+  [method: string]: Route[];
+}

package/lib/utils/index.ts

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

package/lib/utils/{parseJSON.js → parseJSON.ts}

@@ -1,8 +1,10 @@
+import type { CpeakRequest, CpeakResponse, Next } from "../types";
+
 // Parsing JSON
-const parseJSON = (req, res, next) => {
+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 = "") {
+  function isJSON(contentType: string = "") {
     // Remove any params like "; charset=UTF-8"
     const [type] = contentType.split(";");
     return (
@@ -11,10 +13,10 @@ const parseJSON = (req, res, next) => {
     );
   }
 
-  if (!isJSON(req.headers["content-type"])) return next();
+  if (!isJSON(req.headers["content-type"] as string)) return next();
 
   let body = "";
-  req.on("data", (chunk) => {
+  req.on("data", (chunk: Buffer) => {
     body += chunk.toString("utf-8");
   });
 

package/lib/utils/{render.js → render.ts}

@@ -1,8 +1,13 @@
 import fs from "node:fs/promises";
+import { frameworkError } from "../";
+import type { CpeakRequest, CpeakResponse, Next } from "../types";
 
-function renderTemplate(templateStr, data) {
+function renderTemplate(
+  templateStr: string,
+  data: Record<string, unknown>
+): string {
   // Initialize variables
-  let result = [];
+  let result: (string | unknown)[] = [];
 
   let currentIndex = 0;
 
@@ -49,8 +54,20 @@ function renderTemplate(templateStr, data) {
 // @TODO: escape the string to prevent XSS
 // @TODO: add another {{{ }}} option to not escape the string
 const render = () => {
-  return function (req, res, next) {
-    res.render = async (path, data, mime) => {
+  return function (req: CpeakRequest, res: CpeakResponse, next: Next): void {
+    res.render = async (
+      path: string,
+      data: Record<string, unknown>,
+      mime: string
+    ) => {
+      // check if mime is specified, if not return an error
+      if (!mime) {
+        throw frameworkError(
+          `MIME type is missing. You called res.render("${path}", ...) but forgot to provide the third "mime" argument.`,
+          res.render
+        );
+      }
+
       let fileStr = await fs.readFile(path, "utf-8");
       const finalStr = renderTemplate(fileStr, data);
       res.setHeader("Content-Type", mime);

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

@@ -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";
+
+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

@@ -1,11 +1,12 @@
 {
   "name": "cpeak",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "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,21 @@
     "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",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
   "author": "Cododev Technology",
   "license": "MIT",
   "keywords": [
@@ -26,7 +42,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

@@ -1,172 +0,0 @@
-import http from "node:http";
-import fs from "node:fs/promises";
-
-import { serveStatic, parseJSON, render } 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;
-      };
-
-      // Redirects to a new URL
-      res.redirect = (location) => {
-        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) => {
-        // 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, res, middleware, cb, index) => {
-        // Our exit point...
-        if (index === middleware.length) {
-          // Call the route handler with the modified req and res objects
-          return cb(req, res, (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, res, middleware, index) => {
-        // 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, path, ...args) {
-    if (!this.routes[method]) this.routes[method] = [];
-
-    // The last argument is always our handler
-    const cb = args.pop();
-
-    // Rest will be our middleware functions
-    const middleware = args.flat();
-
-    const regex = this.#pathToRegex(path);
-    this.routes[method].push({ path, 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(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, render };
-
-export default Cpeak;

package/lib/utils/index.js

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

package/playground.js

@@ -1,63 +0,0 @@
-function renderTemplate(templateStr, data) {
-  // Initialize variables
-  let result = [];
-  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("");
-}
-
-// Example usage:
-const templateStr = `
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Poster</title>
-
-    <link rel="stylesheet" href="/styles.css" />
-  </head>
-  <body style="color: #333">
-    <h1>{{ msg1 }} {{ msg2 }}</h1>
-
-    <!-- <strong>{{msgBar}}</strong> -->
-
-    <p>
-`;
-
-const data = { msg1: "Alice", msg2: 30 };
-
-const output = renderTemplate(templateStr, data);
-console.log(output); // Output: "Hello, Alice! You are 30 years old."