cpeak 2.2.1 → 2.2.3

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() {

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,6 +1,6 @@
 {
   "name": "cpeak",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "A minimal and fast Node.js HTTP framework.",
   "type": "module",
   "main": "./lib/index.js",

package/test/errors.test.js

@@ -1,40 +0,0 @@
-import assert from "node:assert";
-import supertest from "supertest";
-import cpeak from "../lib/index.js";
-
-const PORT = 7543;
-const request = supertest(`http://localhost:${PORT}`);
-
-describe("Error handling with handleErr", function () {
-  let server;
-
-  before(function (done) {
-    server = new cpeak();
-
-    server.route("patch", "/foo/:bar", (req, res, handleErr) => {
-      const bar = req.vars.bar;
-
-      if (bar === "random") {
-        return handleErr({ status: 403, message: "an error msg" });
-      }
-
-      return res.status(200).json({ bar });
-    });
-
-    server.handleErr((error, req, res) => {
-      return res.status(error.status).json({ error: error.message });
-    });
-
-    server.listen(PORT, done);
-  });
-
-  after(function (done) {
-    server.close(done);
-  });
-
-  it("should get an error using the handleErr function from a router", async function () {
-    const res = await request.patch("/foo/random");
-    assert.strictEqual(res.status, 403);
-    assert.deepStrictEqual(res.body, { error: "an error msg" });
-  });
-});

package/test/files/styles.css

@@ -1,9 +0,0 @@
-/* some styles for testing... */
-.my-class {
-  color: red;
-}
-
-.my-class-2 {
-  color: blue;
-}
-

package/test/files/test.txt

@@ -1 +0,0 @@
-This is a test file.

package/test/files.test.js

@@ -1,35 +0,0 @@
-import assert from "node:assert";
-import supertest from "supertest";
-import fs from "node:fs/promises";
-import cpeak from "../lib/index.js";
-
-const PORT = 7543;
-const request = supertest(`http://localhost:${PORT}`);
-
-describe("Returning files with sendFile", function () {
-  let server;
-
-  before(function (done) {
-    server = new cpeak();
-
-    server.route("get", "/file", (req, res) => {
-      res.status(200).sendFile("./test/files/test.txt", "text/plain");
-    });
-
-    server.listen(PORT, done);
-  });
-
-  after(function (done) {
-    server.close(done);
-  });
-
-  it("should get a file as the response with the correct MIME type", async function () {
-    const res = await request.get("/file");
-
-    const fileContent = await fs.readFile("./test/files/test.txt", "utf-8");
-
-    assert.strictEqual(res.status, 200);
-    assert.strictEqual(res.headers["content-type"], "text/plain");
-    assert.strictEqual(res.text, fileContent);
-  });
-});

package/test/middleware.test.js

@@ -1,68 +0,0 @@
-import assert from "node:assert";
-import supertest from "supertest";
-import cpeak from "../lib/index.js";
-
-const PORT = 7543;
-const request = supertest(`http://localhost:${PORT}`);
-
-describe("Middleware functions", function () {
-  let server;
-
-  before(function (done) {
-    server = new cpeak();
-
-    server.beforeEach((req, res, next) => {
-      const value = req.params.value;
-
-      if (value === "random")
-        return res.status(400).json({ error: "an error msg" });
-
-      next();
-    });
-
-    server.beforeEach((req, res, next) => {
-      req.foo = "text";
-      next();
-    });
-
-    server.beforeEach((req, res, next) => {
-      res.unauthorized = () => {
-        res.statusCode = 401;
-        return res;
-      };
-      next();
-    });
-
-    server.route("get", "/bar", (req, res) => {
-      res.status(200).json({ message: req.foo });
-    });
-
-    server.route("get", "/bar-more", (req, res) => {
-      res.unauthorized().json({});
-    });
-
-    server.listen(PORT, done);
-  });
-
-  after(function (done) {
-    server.close(done);
-  });
-
-  it("should modify the req object with a new property", async function () {
-    const res = await request.get("/bar");
-    assert.strictEqual(res.status, 200);
-    assert.strictEqual(res.body.message, "text");
-  });
-
-  it("should modify the res object with a new method", async function () {
-    const res = await request.get("/bar-more");
-    assert.strictEqual(res.status, 401);
-  });
-
-  it("should exit the middleware and route chain if a middleware wants to", async function () {
-    const res = await request.get("/bar?value=random");
-    assert.strictEqual(res.status, 400);
-    assert.strictEqual(res.body.message, undefined);
-    assert.deepStrictEqual(res.body, { error: "an error msg" });
-  });
-});

package/test/parseJSON.test.js

@@ -1,43 +0,0 @@
-import assert from "node:assert";
-import supertest from "supertest";
-import cpeak, { parseJSON } from "../lib/index.js";
-
-const PORT = 7543;
-const request = supertest(`http://localhost:${PORT}`);
-
-describe("Parsing request bodies with parseJSON", function () {
-  let server;
-
-  before(function (done) {
-    server = new cpeak();
-
-    server.beforeEach(parseJSON);
-
-    server.route("post", "/do-something", (req, res) => {
-      res.status(205).json({ receivedData: req.body });
-    });
-
-    server.listen(PORT, done);
-  });
-
-  after(function (done) {
-    server.close(done);
-  });
-
-  it("should return the same data that was sent in request body as JSON", async function () {
-    const obj = {
-      key1: "value1",
-      key2: 42,
-      key3: {
-        nestedKey1: "nestedValue1",
-        nestedKey2: ["arrayValue1", "arrayValue2", 1000],
-      },
-      key4: true,
-    };
-
-    const res = await request.post("/do-something").send(obj);
-
-    assert.strictEqual(res.status, 205);
-    assert.deepStrictEqual(res.body.receivedData, obj);
-  });
-});

package/test/router.test.js

@@ -1,85 +0,0 @@
-import assert from "node:assert";
-import supertest from "supertest";
-import cpeak from "../lib/index.js";
-
-const PORT = 7543;
-const request = supertest(`http://localhost:${PORT}`);
-
-describe("General route logic & URL variables and parameters", function () {
-  let server;
-
-  before(function (done) {
-    server = new cpeak();
-
-    server.route("get", "/hello", (req, res) => {
-      res.status(200).json({ message: "Hello, World!" });
-    });
-
-    server.route("get", "/document/:title/more/:another/final", (req, res) => {
-      const title = req.vars.title;
-      const another = req.vars.another;
-      const params = req.params;
-
-      res.status(200).json({ title, another, params });
-    });
-
-    server.listen(PORT, done);
-  });
-
-  after(function (done) {
-    server.close(done);
-  });
-
-  it("should return a simple response with no variables and parameters", async function () {
-    const res = await request.get("/hello");
-    assert.strictEqual(res.status, 200);
-    assert.deepStrictEqual(res.body, { message: "Hello, World!" });
-  });
-
-  it("should return a 404 for unknown routes", async function () {
-    const res = await request.get("/unknown");
-    assert.strictEqual(res.status, 404);
-    assert.deepStrictEqual(res.body, {
-      error: "Cannot GET /unknown",
-    });
-  });
-
-  it("should return a 404 for not handled methods", async function () {
-    const res = await request.patch("/random");
-    assert.strictEqual(res.status, 404);
-    assert.deepStrictEqual(res.body, {
-      error: "Cannot PATCH /random",
-    });
-  });
-
-  it("should return the correct URL variables and parameters", async function () {
-    const expectedResponseBody = {
-      title: "some-title",
-      another: "thisISsome__more-text",
-      params: {
-        filter: "comments-date",
-        page: "2",
-        sortBy: "date-desc",
-        tags: JSON.stringify(["nodejs", "express", "url-params"]),
-        author: JSON.stringify({ name: "John Doe", id: 123 }),
-        isPublished: "true",
-        metadata: JSON.stringify({ version: "1.0.0", language: "en" }),
-      },
-    };
-
-    const res = await request
-      .get("/document/some-title/more/thisISsome__more-text/final")
-      .query({
-        filter: "comments-date",
-        page: 2,
-        sortBy: "date-desc",
-        tags: JSON.stringify(["nodejs", "express", "url-params"]),
-        author: JSON.stringify({ name: "John Doe", id: 123 }),
-        isPublished: true,
-        metadata: JSON.stringify({ version: "1.0.0", language: "en" }),
-      });
-
-    assert.strictEqual(res.status, 200);
-    assert.deepStrictEqual(res.body, expectedResponseBody);
-  });
-});

package/test/serveStatic.test.js

@@ -1,53 +0,0 @@
-import assert from "node:assert";
-import supertest from "supertest";
-import fs from "node:fs/promises";
-import cpeak, { serveStatic } from "../lib/index.js";
-
-const PORT = 7543;
-const request = supertest(`http://localhost:${PORT}`);
-
-describe("Serving static files with serveStatic", function () {
-  let server;
-
-  before(function (done) {
-    server = new cpeak();
-
-    server.beforeEach(serveStatic("./test/files", { m4a: "audio/mp4" }));
-
-    server.listen(PORT, done);
-  });
-
-  after(function (done) {
-    server.close(done);
-  });
-
-  it("should return the correct file with the correct MIME type", async function () {
-    const textRes = await request.get("/test.txt");
-    const cssRes = await request.get("/styles.css");
-
-    const fileTextContent = await fs.readFile("./test/files/test.txt", "utf-8");
-    const fileCssContent = await fs.readFile(
-      "./test/files/styles.css",
-      "utf-8"
-    );
-
-    assert.strictEqual(textRes.status, 200);
-    assert.strictEqual(textRes.headers["content-type"], "text/plain");
-    assert.strictEqual(textRes.text, fileTextContent);
-
-    assert.strictEqual(cssRes.status, 200);
-    assert.strictEqual(cssRes.headers["content-type"], "text/css");
-    assert.strictEqual(cssRes.text, fileCssContent);
-  });
-
-  it("should return the correct file with the specified MIME type by the developer", async function () {
-    const res = await request.get("/audio.m4a");
-
-    // read the file as binary
-    const fileBuffer = await fs.readFile("./test/files/audio.m4a");
-
-    assert.strictEqual(res.status, 200);
-    assert.strictEqual(res.headers["content-type"], "audio/mp4");
-    assert.deepStrictEqual(res.body, fileBuffer);
-  });
-});