@wxn0brp/falcon-frame 0.8.4 → 0.8.6

package/README.md

@@ -8,7 +8,6 @@ A minimal, modular TypeScript web library.
 - Middleware chaining
 - Static file serving
 - Request validation via inline schemas
-- OpenAPI document generation
 - Cookie management
 - Debuggable logger
 

package/dist/body-utils.js

@@ -28,7 +28,7 @@ export function getContentType(req) {
 export function getRawBody(req, res, limit) {
     return new Promise((resolve, reject) => {
         let body = "";
-        req.on("data", (chunk) => {
+        req.on("data", chunk => {
             body += chunk.toString();
             if (limit && body.length > limit) {
                 const error = new Error("Payload Too Large");
@@ -41,7 +41,7 @@ export function getRawBody(req, res, limit) {
         req.on("end", () => {
             resolve(body);
         });
-        req.on("error", (err) => {
+        req.on("error", err => {
             reject(err);
         });
     });
@@ -49,7 +49,8 @@ export function getRawBody(req, res, limit) {
 export function getStandardBodyParser(type, parser, opts) {
     const limit = parseLimit(opts.limit || "100k");
     return async (req, res, next) => {
-        if ((typeof req.body == "object" && Object.keys(req.body).length) || getContentType(req) !== type) {
+        if ((typeof req.body === "object" && Object.keys(req.body).length) ||
+            getContentType(req) !== type) {
             return next();
         }
         try {

package/dist/body.js

@@ -1,8 +1,8 @@
 import querystring from "querystring";
 import { getStandardBodyParser } from "./body-utils.js";
 export function json(opts = {}) {
-    return getStandardBodyParser("application/json", (body) => JSON.parse(body), opts);
+    return getStandardBodyParser("application/json", body => JSON.parse(body), opts);
 }
 export function urlencoded(opts = {}) {
-    return getStandardBodyParser("application/x-www-form-urlencoded", (body) => querystring.parse(body), opts);
+    return getStandardBodyParser("application/x-www-form-urlencoded", body => querystring.parse(body), opts);
 }

package/dist/compress.js

@@ -1,4 +1,18 @@
-import { createDeflate, createGzip } from "zlib";
+import { createBrotliCompress, createDeflate, createGzip } from "zlib";
+function isCompressible(contentType) {
+    if (!contentType)
+        return true;
+    const type = contentType.split(";")[0].trim().toLowerCase();
+    if (/^image\/(?!svg\+xml)/.test(type))
+        return false;
+    if (/^(video|audio)\//.test(type))
+        return false;
+    if (type === "text/event-stream")
+        return false;
+    if (/^application\/(zip|gzip|x-gzip|x-bzip|x-bzip2|x-xz|x-rar|x-7z|x-tar|x-compress|wasm)$/.test(type))
+        return false;
+    return true;
+}
 export function compression(req, res) {
     if (req._compression)
         return;
@@ -7,47 +21,69 @@ export function compression(req, res) {
     if (!encoding || typeof encoding !== "string" || res.headersSent) {
         return;
     }
-    let compressionStream;
+    let createCompressor;
     let encodingType;
-    if (/\bgzip\b/.test(encoding)) {
+    if (/\bbr\b/.test(encoding)) {
+        encodingType = "br";
+        createCompressor = createBrotliCompress;
+    }
+    else if (/\bgzip\b/.test(encoding)) {
         encodingType = "gzip";
-        compressionStream = createGzip();
+        createCompressor = createGzip;
     }
     else if (/\bdeflate\b/.test(encoding)) {
         encodingType = "deflate";
-        compressionStream = createDeflate();
+        createCompressor = createDeflate;
     }
     else {
         return;
     }
-    res.setHeader("Content-Encoding", encodingType);
-    res.removeHeader("Content-Length");
     const originalWrite = res.write;
     const originalEnd = res.end;
-    compressionStream.on("data", (chunk) => {
-        originalWrite.call(res, chunk);
-    });
-    compressionStream.on("end", () => {
-        originalEnd.call(res);
-    });
-    compressionStream.on("error", (err) => {
-        if (!res.headersSent) {
-            res.statusCode = 500;
+    let compressionStream = null;
+    let initialized = false;
+    function init() {
+        if (initialized)
+            return compressionStream !== null;
+        initialized = true;
+        const contentType = res.getHeader("content-type");
+        if (!isCompressible(contentType))
+            return false;
+        compressionStream = createCompressor();
+        res.setHeader("Content-Encoding", encodingType);
+        res.removeHeader("Content-Length");
+        compressionStream.on("data", chunk => {
+            originalWrite.call(res, chunk);
+        });
+        compressionStream.on("end", () => {
             originalEnd.call(res);
-        }
-        else {
-            res.destroy(err);
-        }
-    });
-    res.on("close", () => {
-        compressionStream.destroy();
-    });
+        });
+        compressionStream.on("error", err => {
+            if (!res.headersSent) {
+                res.statusCode = 500;
+                originalEnd.call(res);
+            }
+            else {
+                res.destroy(err);
+            }
+        });
+        res.on("close", () => {
+            compressionStream.destroy();
+        });
+        return true;
+    }
     // @ts-ignore
     res.write = (...args) => {
         const [chunk, encoding, cb] = args;
         const callback = typeof encoding === "function" ? encoding : cb;
         const enc = typeof encoding === "function" ? undefined : encoding;
         if (!res.headersSent) {
+            if (!init()) {
+                res.write = originalWrite;
+                res.end = originalEnd;
+                res.writeHead(res.statusCode);
+                return originalWrite.call(res, chunk, enc, callback);
+            }
             res.writeHead(res.statusCode);
         }
         return compressionStream.write(chunk, enc, callback);
@@ -68,6 +104,18 @@ export function compression(req, res) {
             finalCb = encoding;
             finalEncoding = undefined;
         }
+        if (!res.headersSent) {
+            if (!init()) {
+                res.write = originalWrite;
+                res.end = originalEnd;
+                if (finalCb)
+                    res.once("finish", finalCb);
+                if (finalChunk)
+                    originalWrite.call(res, finalChunk, finalEncoding);
+                originalEnd.call(res);
+                return res;
+            }
+        }
         if (finalCb)
             res.once("finish", finalCb);
         if (finalChunk) {

package/dist/cors.js

@@ -9,8 +9,7 @@ function parseOrigin(origin) {
         const url = new URL(origin);
         return {
             host: url.hostname,
-            port: url.port ||
-                (url.protocol === "https:" ? "443" : "80")
+            port: url.port || (url.protocol === "https:" ? "443" : "80"),
         };
     }
     catch {
@@ -68,7 +67,7 @@ export function createCORS(allowedOrigins, opts = {}) {
         const origin = req.headers.origin;
         if (allowedOrigins.includes("*"))
             return handleEnd(req, res, next, origin || "*");
-        if (origin && allowedOrigins.some((pattern) => matches(origin, pattern)))
+        if (origin && allowedOrigins.some(pattern => matches(origin, pattern)))
             return handleEnd(req, res, next, origin);
         next();
     };

package/dist/debug.html

@@ -236,6 +236,11 @@
             text-overflow: ellipsis;
         }
 
+        .url-copy {
+            margin-left: 12px;
+            vertical-align: middle;
+        }
+
         .detail-row td {
             padding: 0;
             background: rgba(22, 27, 34, 0.6);
@@ -253,11 +258,40 @@
             min-width: 240px;
         }
 
+        .detail-section-header {
+            display: flex;
+            justify-content: space-between;
+            align-items: center;
+            margin-bottom: 4px;
+        }
+
         .detail-section h4 {
             font-size: 11px;
             text-transform: uppercase;
             color: var(--text-muted);
-            margin-bottom: 4px;
+            margin: 0;
+        }
+
+        .copy-btn {
+            font-family: var(--font);
+            font-size: 10px;
+            padding: 2px 8px;
+            border-radius: var(--radius);
+            border: 1px solid var(--border);
+            background: transparent;
+            color: var(--text-muted);
+            cursor: pointer;
+            text-transform: uppercase;
+        }
+
+        .copy-btn:hover {
+            border-color: var(--accent);
+            color: var(--accent);
+        }
+
+        .copy-btn.copied {
+            border-color: var(--success);
+            color: var(--success);
         }
 
         .detail-section pre {
@@ -333,9 +367,9 @@
         const methodFilters = document.querySelector("#methodFilters");
         const emptyRow = logBody.querySelector(".empty");
         let entries = [];
-        let seq = 0;
-        let expanded = new Set();
-        let activeMethods = new Set(METHODS);
+        const seq = 0;
+        const expanded = new Set();
+        const activeMethods = new Set(METHODS);
 
         function statusClass(code) {
             if (code < 300) return "s2xx";
@@ -358,6 +392,14 @@
             }
         }
 
+        function isEmpty(obj) {
+            if (!obj || typeof obj !== "object") return true;
+            const keys = Object.keys(obj);
+            if (keys.length === 0) return true;
+            if (keys.length === 1 && keys[0] === "" && obj[""] === "") return true;
+            return false;
+        }
+
         function esc(str) {
             const el = document.createElement("span");
             el.textContent = str;
@@ -414,7 +456,7 @@
                 let html = `<tr data-row="${rowId}">`;
                 html += `<td>${idx}</td>`;
                 html += `<td><span class="method ${e.method.toLowerCase()}">${esc(e.method)}</span></td>`;
-                html += `<td><span class="url-cell" title="${escUrl}">${escUrl}</span></td>`;
+                html += `<td><span class="url-cell" title="${escUrl}">${escUrl}</span><button class="copy-btn url-copy" data-copy-url="${esc(e.url.replace(/"/g, '&quot;'))}">Copy</button></td>`;
                 html += `<td><span class="status ${statusClass(e.status)}">${e.status}</span></td>`;
                 html += `<td><span class="duration ${durationClass(e.duration)}">${dur}</span></td>`;
                 html += `<td class="time">${new Date(e.time).toLocaleTimeString()}</td>`;
@@ -423,10 +465,10 @@
                 if (isExpanded) {
                     html += `<tr class="detail-row"><td colspan="6">`;
                     html += `<div class="detail-inner">`;
-                    html += `<div class="detail-section"><h4>Headers</h4><pre>${esc(formatJSON(e.headers))}</pre></div>`;
-                    html += `<div class="detail-section"><h4>Query</h4><pre>${esc(formatJSON(e.query))}</pre></div>`;
-                    html += `<div class="detail-section"><h4>Cookies</h4><pre>${esc(formatJSON(e.cookies))}</pre></div>`;
-                    html += `<div class="detail-section"><h4>Body</h4><pre>${esc(formatJSON(e.body))}</pre></div>`;
+                    if (!isEmpty(e.headers)) html += `<div class="detail-section"><div class="detail-section-header"><h4>Headers</h4><button class="copy-btn" data-copy>Copy</button></div><pre>${esc(formatJSON(e.headers))}</pre></div>`;
+                    if (!isEmpty(e.query)) html += `<div class="detail-section"><div class="detail-section-header"><h4>Query</h4><button class="copy-btn" data-copy>Copy</button></div><pre>${esc(formatJSON(e.query))}</pre></div>`;
+                    if (!isEmpty(e.cookies)) html += `<div class="detail-section"><div class="detail-section-header"><h4>Cookies</h4><button class="copy-btn" data-copy>Copy</button></div><pre>${esc(formatJSON(e.cookies))}</pre></div>`;
+                    if (!isEmpty(e.body)) html += `<div class="detail-section"><div class="detail-section-header"><h4>Body</h4><button class="copy-btn" data-copy>Copy</button></div><pre>${esc(formatJSON(e.body))}</pre></div>`;
                     html += `</div></td></tr>`;
                 }
 
@@ -435,6 +477,35 @@
         }
 
         logBody.addEventListener("click", (e) => {
+            const copyBtn = e.target.closest("[data-copy]");
+            if (copyBtn) {
+                const pre = copyBtn.closest(".detail-section").querySelector("pre");
+                navigator.clipboard.writeText(pre.textContent).then(() => {
+                    copyBtn.textContent = "Copied!";
+                    copyBtn.classList.add("copied");
+                    setTimeout(() => {
+                        copyBtn.textContent = "Copy";
+                        copyBtn.classList.remove("copied");
+                    }, 1500);
+                });
+                return;
+            }
+
+            const urlCopyBtn = e.target.closest("[data-copy-url]");
+            if (urlCopyBtn) {
+                navigator.clipboard.writeText(urlCopyBtn.dataset.copyUrl).then(() => {
+                    urlCopyBtn.textContent = "Copied!";
+                    urlCopyBtn.classList.add("copied");
+                    setTimeout(() => {
+                        urlCopyBtn.textContent = "Copy";
+                        urlCopyBtn.classList.remove("copied");
+                    }, 1500);
+                });
+                return;
+            }
+
+            if (e.target.closest(".detail-row")) return;
+
             const row = e.target.closest("tr[data-row]");
             if (!row) return;
             const rid = row.dataset.row;

package/dist/debug.js

@@ -1,13 +1,19 @@
 import { join } from "path";
 import { Router } from "./router.js";
 export function createDebug(opts = {}) {
-    const { url = "/debug", hosts = ["localhost", "127.0.0.1", "::1"], } = opts;
+    const { url = "/debug", hosts = [
+        "localhost",
+        "127.0.0.1",
+        "::1",
+    ], } = opts;
     if (process.env.NODE_ENV === "production" &&
         !process.env.FF_DEBUG_PRODUCTION_ENABLED)
-        return (req, res, next) => { next(); };
+        return (req, res, next) => {
+            next();
+        };
     const pass = process.env.FF_DEBUG_PASS;
     function isHostAllowed(req) {
-        return hosts.some((h) => h === req.socket.remoteAddress);
+        return hosts.some(h => h === req.socket.remoteAddress);
     }
     function checkAuth(req) {
         if (!pass)
@@ -31,7 +37,7 @@ export function createDebug(opts = {}) {
     router.use("/", (req, res, next) => {
         const start = Date.now();
         const hook = res.end.bind(res);
-        res.end = function (...args) {
+        res.end = (...args) => {
             const entry = {
                 method: req.method,
                 url: req.url,

package/dist/helpers.js

@@ -1,7 +1,7 @@
 import path from "path";
 export function parseCookies(cookieHeader) {
     const cookies = {};
-    cookieHeader.split(";").forEach((cookie) => {
+    cookieHeader.split(";").forEach(cookie => {
         const [name, ...valueParts] = cookie.split("=");
         const value = decodeURIComponent(valueParts.join("=").trim());
         cookies[name.trim()] = value;
@@ -32,4 +32,4 @@ export function getContentType(filePath, utf8 = false) {
         contentType += "; charset=utf-8";
     return contentType;
 }
-export const ensureLeadingDot = (str) => (str.startsWith(".") ? str : "." + str);
+export const ensureLeadingDot = (str) => str.startsWith(".") ? str : "." + str;

package/dist/index.d.ts

@@ -29,7 +29,7 @@ export declare class FalconFrame<Vars extends Record<string, any> = {}> extends
      * @param [origin] - An array of allowed origins. (default: ["*"])
      * @example
      * app.setOrigin(["http://example.com", "https://example.com"]);
-    */
+     */
     setOrigin(origin?: string[] | string): void;
     /**
      * Listens to the specified port, or the environment variable PORT if available.

package/dist/index.js

@@ -12,7 +12,7 @@ export class FalconFrame extends Router {
     vars = {};
     opts = {};
     engines = {};
-    _400_formatter = (err) => {
+    _400_formatter = err => {
         return {
             err: true,
             msg: "Bad request",
@@ -40,9 +40,13 @@ export class FalconFrame extends Router {
             ...opts,
         };
         if (!this.opts.disableJsonParser)
-            this.addBodyParser(json({ limit: this.opts.bodyLimit }));
+            this.addBodyParser(json({
+                limit: this.opts.bodyLimit,
+            }));
         if (!this.opts.disableUrlencodedParser)
-            this.addBodyParser(urlencoded({ limit: this.opts.bodyLimit }));
+            this.addBodyParser(urlencoded({
+                limit: this.opts.bodyLimit,
+            }));
         this.engine(".html", (path, data, callback, FF) => {
             try {
                 const content = renderHTML({
@@ -122,9 +126,13 @@ export class FalconFrame extends Router {
      * @param [origin] - An array of allowed origins. (default: ["*"])
      * @example
      * app.setOrigin(["http://example.com", "https://example.com"]);
-    */
+     */
     setOrigin(origin = "*") {
-        this.use(createCORS(Array.isArray(origin) ? origin : [origin]));
+        this.use(createCORS(Array.isArray(origin)
+            ? origin
+            : [
+                origin,
+            ]));
     }
     /**
      * Listens to the specified port, or the environment variable PORT if available.

package/dist/middleware.js

@@ -26,7 +26,7 @@ export function matchMiddleware(url, middlewares) {
             let matches = true;
             for (let i = 0; i < middlewareParts.length; i++) {
                 if (middlewareParts[i].startsWith(":")) {
-                    continue;
+                    // continue;
                 }
                 else if (middlewareParts[i] !== urlParts[i]) {
                     matches = false;
@@ -62,7 +62,10 @@ export function getMiddlewares(middlewares, matchUrl, basePath = "") {
             result.push(...nested);
         }
         else {
-            result.push({ ...middleware, path: fullPath });
+            result.push({
+                ...middleware,
+                path: fullPath,
+            });
         }
     }
     return result;

package/dist/render.js

@@ -35,7 +35,10 @@ export function renderHTML(options) {
             const partialPath = path.join(path.dirname(templatePath), partialName + ".html");
             return renderHTML({
                 templatePath: partialPath,
-                _renderedPaths: [...renderedPaths, realPath],
+                _renderedPaths: [
+                    ...renderedPaths,
+                    realPath,
+                ],
                 noLayout: true,
                 data,
                 FF,
@@ -67,9 +70,12 @@ export function renderHTML(options) {
                 templatePath: FFLayout,
                 data: {
                     ...data,
-                    body: template
+                    body: template,
                 },
-                _renderedPaths: [...renderedPaths, realPath],
+                _renderedPaths: [
+                    ...renderedPaths,
+                    realPath,
+                ],
                 noLayout: true,
                 FF,
                 FFVar,

package/dist/req.js

@@ -10,7 +10,7 @@ export function handleRequest(req, res, FF, reRoute = false) {
         req.FF = FF;
         res.FF = FF;
         const originalEnd = res.end;
-        res.end = function (...any) {
+        res.end = (...any) => {
             res._ended = true;
             return originalEnd.call(res, ...any);
         };
@@ -31,7 +31,7 @@ export function handleRequest(req, res, FF, reRoute = false) {
     req.cookies = parseCookies(req.headers.cookie || "");
     req.params = {};
     req.valid = (schema) => validate(schema, req.body);
-    req.reRoute = (fn) => {
+    req.reRoute = fn => {
         fn(req);
         handleRequest(req, res, FF, true);
     };
@@ -49,11 +49,11 @@ export function handleRequest(req, res, FF, reRoute = false) {
         (req.id ? ` [${req.id}]` : ""));
     const middlewaresPath = req.path + "/";
     const middlewares = getMiddlewares(FF.middlewares, middlewaresPath.replace(/\/+/g, "/"));
-    const matchedTypeMiddlewares = middlewares.filter((middleware) => middleware.method === req.method.toLowerCase() ||
+    const matchedTypeMiddlewares = middlewares.filter(middleware => middleware.method === req.method.toLowerCase() ||
         middleware.method === "all");
     const matchedMiddlewares = matchMiddleware(req.path, matchedTypeMiddlewares);
     logger.debug("Matched middlewares: " +
-        matchedMiddlewares.map((middleware) => middleware.path).join(", "));
+        matchedMiddlewares.map(middleware => middleware.path).join(", "));
     if (matchedMiddlewares.length === 0) {
         res.status(404);
         FF._404(req, res);

package/dist/res.js

@@ -108,7 +108,7 @@ export class FFResponse extends http.ServerResponse {
     render(view, data = {}, opts = {}) {
         const ff = this.FF;
         const viewsDir = opts.baseDir ??
-            (opts.notUseViews ? "." : (ff.getVar("views") || "."));
+            (opts.notUseViews ? "." : ff.getVar("views") || ".");
         let engineName = path.extname(view);
         let filePath = view;
         if (opts.engine) {

package/dist/router.js

@@ -4,8 +4,12 @@ export class Router {
     middlewares = [];
     addRoute(method, path, ...handlers) {
         const handler = handlers.pop();
-        handlers.forEach((middleware) => this.use(path, middleware));
-        return this.middlewares.push({ path, middleware: handler, method });
+        handlers.forEach(middleware => this.use(path, middleware));
+        return this.middlewares.push({
+            path,
+            middleware: handler,
+            method,
+        });
     }
     use(path = "/", middlewareFn, method = "all") {
         if (typeof path !== "string") {

package/dist/sse.js

@@ -5,7 +5,10 @@ export class SSEManager {
         return (req, res, next) => {
             res.sseInit();
             const id = randomUUID();
-            this._clients.set(id, { req, res });
+            this._clients.set(id, {
+                req,
+                res,
+            });
             req.on("close", () => {
                 this._clients.delete(id);
             });

package/dist/static.js

@@ -16,11 +16,16 @@ export function handleStaticFiles(dirPath, opts) {
     const serveFile = (req, res, filePath, stats) => {
         if (opts.render) {
             const defaultRenderer = res.FF.getVar("view engine");
-            const renderStatement = (defaultRenderer && filePath.endsWith(ensureLeadingDot(defaultRenderer))) ||
+            const renderStatement = (defaultRenderer &&
+                filePath.endsWith(ensureLeadingDot(defaultRenderer))) ||
                 (!opts.notRenderHtml && filePath.endsWith(".html"));
             if (renderStatement) {
-                const relativePath = filePath.replace(dirPath + "/", "").replace(".html", "");
-                res.render(filePath, opts.renderData?.[relativePath] || {}, { notUseViews: true });
+                const relativePath = filePath
+                    .replace(dirPath + "/", "")
+                    .replace(".html", "");
+                res.render(filePath, opts.renderData?.[relativePath] || {}, {
+                    notUseViews: true,
+                });
                 return true;
             }
         }

package/dist/types.d.ts

@@ -88,7 +88,7 @@ export interface FFOpts {
 export type FFVars = {
     "render data": Record<string, any>;
     "view engine": string;
-    "views": string;
-    "layout": string;
+    views: string;
+    layout: string;
 };
 export type CombinedVars<ExtraVars> = ExtraVars & FFVars;

package/dist/valid.js

@@ -24,8 +24,7 @@ export function validate(schema, data) {
                     }
                     break;
                 case "min":
-                    if (typeof value === "string" &&
-                        value.length < parseInt(param)) {
+                    if (typeof value === "string" && value.length < parseInt(param)) {
                         fieldErrors.push(`${key} must be at least ${param} characters long`);
                     }
                     if (typeof value === "number" && value < parseInt(param)) {
@@ -33,20 +32,20 @@ export function validate(schema, data) {
                     }
                     break;
                 case "max":
-                    if (typeof value === "string" &&
-                        value.length > parseInt(param)) {
+                    if (typeof value === "string" && value.length > parseInt(param)) {
                         fieldErrors.push(`${key} must not exceed ${param} characters`);
                     }
                     if (typeof value === "number" && value > parseInt(param)) {
                         fieldErrors.push(`${key} must not exceed ${param}`);
                     }
                     break;
-                case "email":
+                case "email": {
                     const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
                     if (!emailRegex.test(value)) {
                         fieldErrors.push(`${key} must be a valid email`);
                     }
                     break;
+                }
             }
         }
         if (fieldErrors.length > 0) {
@@ -54,7 +53,10 @@ export function validate(schema, data) {
             errors[key] = fieldErrors;
         }
     }
-    return { valid: isValid, validErrors: errors };
+    return {
+        valid: isValid,
+        validErrors: errors,
+    };
 }
 export function validateBody(schema) {
     return (req, res, next) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/falcon-frame",
-  "version": "0.8.4",
+  "version": "0.8.6",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -24,6 +24,7 @@
   ],
   "devDependencies": {
     "@types/node": "*",
+    "@wxn0brp/biome": "*",
     "tsc-alias": "*",
     "typescript": "^7"
   },