cpeak 2.5.0 → 2.7.0

package/lib/utils/render.ts

@@ -1,5 +1,6 @@
 import fs from "node:fs/promises";
 import { frameworkError } from "../";
+import { compressAndSend } from "../internal/compression";
 import type { CpeakRequest, CpeakResponse, Next } from "../types";
 
 function renderTemplate(
@@ -70,6 +71,12 @@ const render = () => {
 
       let fileStr = await fs.readFile(path, "utf-8");
       const finalStr = renderTemplate(fileStr, data);
+
+      if (res._compression) {
+        await compressAndSend(res, mime, finalStr, res._compression);
+        return;
+      }
+
       res.setHeader("Content-Type", mime);
       res.end(finalStr);
     };

package/lib/utils/serveStatic.ts

@@ -17,14 +17,24 @@ const MIME_TYPES: StringMap = {
   ttf: "font/ttf",
   woff: "font/woff",
   woff2: "font/woff2",
+  gif: "image/gif",
+  ico: "image/x-icon",
+  json: "application/json",
+  webmanifest: "application/manifest+json"
 };
 
-const serveStatic = (folderPath: string, newMimeTypes?: StringMap) => {
+const serveStatic = (
+  folderPath: string,
+  newMimeTypes?: StringMap,
+  options?: { prefix?: string }
+) => {
   // For new user defined mime types
   if (newMimeTypes) {
     Object.assign(MIME_TYPES, newMimeTypes);
   }
 
+  const prefix = options?.prefix ?? "";
+
   function processFolder(folderPath: string, parentFolder: string) {
     const staticFiles: string[] = [];
 
@@ -55,9 +65,9 @@ const serveStatic = (folderPath: string, newMimeTypes?: StringMap) => {
     const filesMap: Record<string, { path: string; mime: string }> = {};
     for (const file of filesArray) {
       const fileExtension = path.extname(file).slice(1);
-      filesMap[file] = {
+      filesMap[prefix + file] = {
         path: folderPath + file,
-        mime: MIME_TYPES[fileExtension],
+        mime: MIME_TYPES[fileExtension]
       };
     }
     return filesMap;
@@ -70,8 +80,9 @@ const serveStatic = (folderPath: string, newMimeTypes?: StringMap) => {
     const url = req.url;
     if (typeof url !== "string") return next();
 
-    if (Object.prototype.hasOwnProperty.call(filesMap, url)) {
-      const fileRoute = filesMap[url];
+    const pathname = url.split("?")[0];
+    if (Object.prototype.hasOwnProperty.call(filesMap, pathname)) {
+      const fileRoute = filesMap[pathname];
       return res.sendFile(fileRoute.path, fileRoute.mime);
     }
 

package/lib/utils/swagger.ts

@@ -0,0 +1,31 @@
+import type { CpeakRequest, CpeakResponse, Next } from "../types";
+
+const swagger = (spec: object, prefix = "/api-docs") => {
+  const initializerJs = `window.onload = function() {
+  SwaggerUIBundle({
+    url: "${prefix}/spec.json",
+    dom_id: '#swagger-ui',
+    presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+    layout: "StandaloneLayout"
+  });
+};`;
+
+  return (req: CpeakRequest, res: CpeakResponse, next: Next) => {
+    if (req.url === prefix || req.url === `${prefix}/`) {
+      res.writeHead(302, { Location: `${prefix}/index.html` });
+      res.end();
+      return;
+    }
+    if (req.url === `${prefix}/spec.json`) {
+      return res.json(spec);
+    }
+    if (req.url === `${prefix}/swagger-initializer.js`) {
+      res.setHeader("Content-Type", "application/javascript");
+      res.end(initializerJs);
+      return;
+    }
+    next();
+  };
+};
+
+export { swagger };

package/lib/utils/types.ts

@@ -0,0 +1,51 @@
+export interface PbkdfOptions {
+  iterations?: number;
+  keylen?: number;
+  digest?: string;
+  saltSize?: number;
+}
+
+export interface AuthOptions extends PbkdfOptions {
+  secret: string;
+  saveToken: (
+    tokenId: string,
+    userId: string,
+    expiresAt: Date
+  ) => Promise<void>;
+  findToken: (
+    tokenId: string
+  ) => Promise<{ userId: string; expiresAt: Date } | null>;
+  tokenExpiry?: number;
+  hmacAlgorithm?: string;
+  tokenIdSize?: number;
+  revokeToken?: (tokenId: string) => Promise<void>;
+}
+
+export interface CookieOptions {
+  signed?: boolean;
+  httpOnly?: boolean;
+  secure?: boolean;
+  sameSite?: "strict" | "lax" | "none";
+  maxAge?: number; // ms
+  expires?: Date;
+  path?: string;
+  domain?: string;
+}
+
+export type OriginInput =
+  | string
+  | string[]
+  | RegExp
+  | boolean
+  | ((origin: string | undefined) => boolean | Promise<boolean>);
+
+export interface CorsOptions {
+  origin?: OriginInput;
+  methods?: string | string[];
+  allowedHeaders?: string | string[];
+  exposedHeaders?: string | string[];
+  credentials?: boolean;
+  maxAge?: number;
+  preflightContinue?: boolean;
+  optionsSuccessStatus?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cpeak",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "A minimal and fast Node.js HTTP framework.",
   "type": "module",
   "scripts": {
@@ -10,12 +10,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/agile8118/cpeak.git"
+    "url": "https://github.com/Cododev-Technology/cpeak.git"
   },
   "bugs": {
-    "url": "https://github.com/agile8118/cpeak/issues"
+    "url": "https://github.com/Cododev-Technology/cpeak/issues"
   },
-  "homepage": "https://github.com/agile8118/cpeak#readme",
+  "homepage": "https://github.com/Cododev-Technology/cpeak#readme",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",