cpeak 2.2.0 → 2.2.2

package/README.md

@@ -1,5 +1,7 @@
 # Cpeak
 
+[![npm version](https://badge.fury.io/js/cpeak.svg)](https://www.npmjs.com/package/cpeak)
+
 Cpeak is a minimal and fast Node.js framework inspired by Express.js.
 
 This project is designed to be improved until it's ready for use in complex production applications, aiming to be more performant and minimal than Express.js. This framework is intended for HTTP applications that primarily deal with JSON and file-based message bodies.
@@ -40,6 +42,8 @@ Ready to dive in? Install **Cpeak** via npm:
 npm install cpeak
 ```
 
+Cpeak is a **pure ESM** package, and to use it, your project needs to be an ESM as well. You can learn more about that [here](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+
 ### Hello World App:
 
 ```javascript

package/lib/index.js

@@ -1,7 +1,7 @@
 import http from "node:http";
 import fs from "node:fs/promises";
 
-import { serveStatic, parseJSON } from "./util.js";
+import { serveStatic, parseJSON } from "./utils/index.js";
 
 class Cpeak {
   constructor() {
@@ -37,29 +37,32 @@ class Cpeak {
       // 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) {
-          for (const route of this.routes[req.method.toLowerCase()]) {
-            const match = urlWithoutParams.match(route.regex);
-
-            if (match) {
-              // Parse the URL parameters (like /users?key1=value1&key2=value2)
-              const params = new URLSearchParams(req.url.split("?")[1]);
-              req.params = Object.fromEntries(params.entries());
-
-              // 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);
-              });
+          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
@@ -92,9 +95,11 @@ class Cpeak {
   }
 
   listen(port, cb) {
-    this.server.listen(port, () => {
-      cb();
-    });
+    this.server.listen(port, cb);
+  }
+
+  close(cb) {
+    this.server.close(cb);
   }
 
   // ------------------------------

package/lib/utils/index.js

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

package/lib/utils/parseJSON.js

@@ -0,0 +1,20 @@
+// 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 };

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

@@ -74,23 +74,4 @@ const serveStatic = (folderPath, newMimeTypes) => {
   };
 };
 
-// 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 { serveStatic, parseJSON };
+export { serveStatic };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "cpeak",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "A minimal and fast Node.js HTTP framework.",
   "type": "module",
   "main": "./lib/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha test/**/*.js"
   },
   "repository": {
     "type": "git",
@@ -22,5 +22,9 @@
     "nodejs",
     "http",
     "framework"
-  ]
+  ],
+  "devDependencies": {
+    "mocha": "^10.7.3",
+    "supertest": "^7.0.0"
+  }
 }

package/private.txt

@@ -0,0 +1,351 @@
+NPM publish
+
+after making a regular comment:
+1- update package.json version number
+2- git commit -am '2.2.0'
+3- git tag v2.2.0
+4- npm publish
+5- git push
+6- git push --tags
+
+
+https://www.freecodecamp.org/news/how-to-create-and-publish-your-first-npm-package/
+
+https://cloudfour.com/thinks/how-to-publish-an-updated-version-of-an-npm-package/
+
+git push --tags
+
+
+
+
+
+
+
+A minimal and fast Node.js framework aiming to become one of the best. Every step of the development is explained and documented for educational purposes.
+
+
+For documentation refer to here: [cododev.ca/cpeak]
+
+
+
+
+
+
+rm -rf nodemodules && npm i
+
+
+README Backup:
+# Cpeak
+
+Cpeak is a minimal and fast Node.js framework inspired by Express.js.
+
+This project is meant to be improved to be ready for use in complex production applications, and be more performant and minimal than Express.js. This frameworks is for HTTP applications that just deal with with JSON and file-based message bodies.
+
+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, and if you want to learn how to build a framework like this, and also get to a point to be bale to build things like these yourself, checkout out this course!
+
+## Why Cpeak?
+
+- **Minimalism**: No unnecessary bloat, with zero dependencies. Just the core essentials you need to build fast and reliable applications.
+- **Performance**: Engineered to be fast, **Cpeak** won't sacrifice speed for excessive customizability.
+- **Educational**: Every new change that is made in the project, will be explained in great detail in this YouTube Playlist (playlist will be added soon). Follow this project, and let's see what it takes to build an industry leading product!
+- **Expess.js Compatible**: You can easily refactor from Cpeak to Express.js and vice versa. Many NPM packages that work with Express.js will also work with Cpeak.
+
+## Getting Starter
+
+Ready to dive in? Install **Cpeak** via npm:
+
+```bash
+npm install cpeak
+```
+
+#### Hello World App:
+
+```javascript
+import cpeak from "cpeak";
+
+const server = new cpeak();
+
+server.route("get", "/", (req, res) => {
+  res.json({ message: "Hi there!" });
+});
+
+server.listen(3000, () => {
+  console.log("Server has started on port 3000");
+});
+```
+
+## Documentation
+
+#### Including
+
+Include the framework like this:
+
+```
+import cpeak from "cpeak";
+```
+
+Because of the minimalistic philosophy, you will not add in unnecessary objects to your memory as soon as you include the framework. If at any point you want to use a particular utility function (like pareJSON and serveStatic), include that like the line below, and only at that point in will be moved to your memory:
+
+```
+import cpeak, { serveStatic, parseJSON } from "cpeak";
+```
+
+#### Initializing
+
+Initialize the Cpeak server like this:
+
+```
+const server = new cpeak();
+```
+
+Now you can use this server object to start listening, add route logic, add middleware functions, and also handle errors.
+
+#### Middleware
+
+If you add a middleware function, that function will run before your route logic kicks in. Here you can customize the request object, return an error, or do anything else that you want to do prior to your route logics like authentication.
+
+After calling next, the next middleware functions is going to run if there's any, otherwise the route logic is going to run.
+
+```javascript
+server.beforeEach((req, res, next) => {
+  if (req.headers.authentication) {
+    // Your authentication logic...
+    req.userId = "<something>";
+    req.custom = "This is some string";
+    next();
+  } else {
+    // Return an error and close the request...
+    return res.status(401).json({ error: "Unauthorized" });
+  }
+});
+
+server.beforeEach((req, res, next) => {
+  console.log(
+    "The custom was added from the previous middleware: ",
+    req.custom
+  );
+  next();
+});
+```
+
+#### Route Handling
+
+You can add in new routes like this:
+
+```javascript
+server.route("patch", "/the-path-you-want", (req, res) => {
+  // your route logic
+});
+```
+
+The req and res object types are the same with the Node.js HTTP module (http.IncomingMessage and http.ServerResponse). You can read more about them in the [official Node.js documentation](https://nodejs.org/docs/latest/api/http.html).
+
+#### URL Variables & Parameters
+
+Because in HTTP these are called URL parameters: `/path?key1=value1&key2=value2&foo=900`, here in Cpeak we also call them params short for HTTP URL parameters.
+We can also do custom path management, and we call them vars short for URL variables.
+
+Here's how we can read both:
+
+```javascript
+// Imaging request URL is example.com/test/my-title/more-text?filter=newest
+server.route("patch", "/test/:title/more-text", (req, res) => {
+  const title = req.vars.title;
+  const filter = req.params.get("filter");
+
+  console.log(title); // my-title
+  console.log(filter); // newest
+});
+```
+
+#### Sending Files
+
+You can send a file as a Node.js Stream anywhere in your route or middleware logic like this:
+
+```javascript
+server.route("get", "/testing", (req, res) => {
+  return res.status(200).sendFile("<file-path>", "<mime-type>");
+
+  // Example:
+  // return res.status(200).sendFile("./images/sun.jpeg", "image/jpeg");
+});
+```
+
+The file 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.
+
+#### Error Handling
+
+If anywhere in you route functions, you want to return an error, it's better to pass to the handleErr function like this:
+
+```javascript
+server.route("get", "/api/document/:title", (req, res, handleErr) => {
+  const title = req.vars.title;
+
+  // Handling errors
+  if (title.length > 500)
+    return handleErr({ status: 400, message: "Title too long." });
+
+  // The rest of your logic...
+});
+```
+
+And then handle all the errors like here in the handleErr callback:
+
+```javascript
+server.handleErr((error, req, res) => {
+  if (error && error.status) {
+    res.status(error.status).json({ error: error.message });
+  } else {
+    // Log the unexpected errors somewhere so you can keep track of them...
+    console.error(error);
+    res.status(500).json({
+      error: "Sorry, something unexpected happened from our side.",
+    });
+  }
+});
+```
+
+The error object is the object that you passed to the handleErr function before in your routes.
+
+#### Listening
+
+Start listening on a specific port like this:
+
+```javascript
+server.listen(3000, () => {
+  console.log("Server has started on port 3000");
+});
+```
+
+### Util Functions
+
+There are utility functions that you can include and use as middleware functions. These are meant to make it easier for you to make HTTP applications. In the future, many more will be added, and you only move them to your memory once you include them. No need to have many NPM dependencies for simple applications!
+
+The list of utility functions as of now:
+
+- serveStatic
+- parseJSON
+
+Including any one of them is like this:
+
+```javascript
+import cpeak, { utilName } from "cpeak";
+```
+
+#### serveStatic
+
+With this middleware function, you can automatically set a folder in your project to be served by Cpeak. Here's how to set it up:
+
+```javascript
+server.beforeEach(
+  serveStatic("./public", {
+    mp3: "audio/mpeg",
+  })
+);
+```
+
+If you have file types in your public folder that are not one of the followings, make sure to add the MIME types manually as the second argument in the function as an object where each property key is the file extension, and each value is the correct MIME type for that. You can see all the available MIME types from [iana website](https://www.iana.org/assignments/media-types/media-types.xhtml) .
+
+```
+  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"
+```
+
+#### parseJSON
+
+With this middleware function, you can easily read and send JSON in HTTP message bodies in route and middleware functions. Fire it up like this:
+
+```javascript
+server.beforeEach(parseJSON);
+```
+
+Read and send JSON from HTTP messages like this:
+
+```javascript
+server.route("put", "/api/user", (req, res) => {
+  // Reading JSON from the HTTP request:
+  const email = req.body.email;
+
+  // rest of your logic...
+
+  // Sending JSON in the HTTP response:
+  res.status(201).json({ message: "Something was created..." });
+});
+```
+
+## Complete Example
+
+Here you can see all the features the Cpeak offers, in one small piece of code:
+
+```javascript
+import cpeak, { serveStatic, parseJSON } from "cpeak";
+
+const server = new cpeak();
+
+server.beforeEach(
+  serveStatic("./public", {
+    mp3: "audio/mpeg",
+  })
+);
+
+// For parsing JSON body
+server.beforeEach(parseJSON);
+
+// Adding custom middleware functions
+server.beforeEach((req, res, next) => {
+  req.custom = "This is some string";
+  next();
+});
+
+// Adding route handlers
+server.route("get", "/api/document/:title", (req, res, handleErr) => {
+  // Reading URL variables
+  const title = req.vars.title;
+
+  // Reading URL parameters (like /users?filter=active)
+  const filter = req.params.get("filter");
+
+  // Reading JSON request body
+  const anything = req.body.anything;
+
+  // Handling errors
+  if (anything === "not-expected-thing")
+    return handleErr({ status: 401, 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...
+  res.status(200).sendFile("<path-to-file-relative-to-cwd>", "<mime-type>");
+});
+
+// Handle all the errors that could happen in the routes
+server.handleErr((error, req, res) => {
+  if (error && error.status) {
+    res.status(error.status).json({ error: error.message });
+  } else {
+    console.error(error);
+    res.status(500).json({
+      error: "Sorry, something unexpected happened from our side.",
+    });
+  }
+});
+
+server.listen(3000, () => {
+  console.log("Server has started on port 3000");
+});
+```