@wxn0brp/falcon-frame 0.4.1 → 0.5.1

package/README.md

@@ -4,8 +4,6 @@
 
 **FalconFrame** is a minimalist web framework inspired by the middleware-first style, with routing similar to Express, but written in pure TypeScript. It supports static files, data validation, and cookie management, all without external dependencies apart from a logger.
 
----
-
 ## ✨ Features
 
 - 🚀 Zero-dependency routing engine
@@ -15,8 +13,6 @@
 - 🍪 Cookie management
 - 🔍 Debuggable logger
 
----
-
 ## 📦 Installation
 
 ```bash
@@ -27,16 +23,9 @@ yarn add @wxn0brp/falcon-frame
 
 ```ts
 import FalconFrame from "@wxn0brp/falcon-frame";
-import { createCORSPlugin } from "@wxn0brp/falcon-frame/plugins/cors";
 const app = new FalconFrame();
 
-const pluginSystem = new PluginSystem();
-
-// Initialize CORS plugin
-pluginSystem.register(createCORSPlugin(["http://localhost:3000", "https://example.com"]));
-
-// Register plugins
-app.use(pluginSystem.getRouteHandler());
+app.setOrigin("*");
 
 const USERS = {
     admin: "hunter2",
@@ -112,9 +101,8 @@ app.all("*", (req, res) => {
     res.status(404).json({ error: "Not found" });
 });
 
-app.listen(3000, () => {
-    console.log("Server running on http://localhost:3000");
-});
+// Start the server (env.PORT || 3000)
+app.l(3000);
 ```
 
 ## 📜 License

package/dist/cors.d.ts

@@ -0,0 +1,7 @@
+import { RouteHandler } from "./types.js";
+export interface Opts {
+    accessControlAllowMethods?: boolean;
+    accessControlAllowHeaders?: boolean;
+    headers?: Record<string, string>;
+}
+export declare function createCORS(allowedOrigins: string[], opts?: Opts): RouteHandler;

package/dist/cors.js

@@ -0,0 +1,39 @@
+function setHeader(res, opts) {
+    if (opts.accessControlAllowMethods)
+        res.setHeader("Access-Control-Allow-Methods", "GET,POST,PUT,DELETE,OPTIONS");
+    if (opts.accessControlAllowHeaders)
+        res.setHeader("Access-Control-Allow-Headers", "Content-Type, Authorization");
+}
+export function createCORS(allowedOrigins, opts = {}) {
+    opts = {
+        accessControlAllowMethods: true,
+        accessControlAllowHeaders: true,
+        ...opts,
+    };
+    return (req, res, next) => {
+        if (opts.headers) {
+            for (const [key, value] of Object.entries(opts.headers)) {
+                res.setHeader(key, value);
+            }
+        }
+        if (allowedOrigins.includes("*")) {
+            res.setHeader("Access-Control-Allow-Origin", "*");
+            setHeader(res, opts);
+            if (req.method === "OPTIONS") {
+                res.statusCode = 204;
+                return res.end();
+            }
+            return next();
+        }
+        const origin = req.headers.origin;
+        if (origin && allowedOrigins.includes(origin)) {
+            res.setHeader("Access-Control-Allow-Origin", origin);
+            setHeader(res, opts);
+            if (req.method === "OPTIONS") {
+                res.statusCode = 204;
+                return res.end();
+            }
+        }
+        next();
+    };
+}

package/dist/helpers.d.ts

@@ -2,3 +2,4 @@ import { Cookies, RouteHandler, StaticServeOptions } from "./types.js";
 export declare function parseCookies(cookieHeader: string): Cookies;
 export declare function getContentType(filePath: string, utf8?: boolean): string;
 export declare function handleStaticFiles(dirPath: string, opts: StaticServeOptions): RouteHandler;
+export declare const ensureLeadingDot: (str: string) => string;

package/dist/helpers.js

@@ -45,6 +45,15 @@ export function handleStaticFiles(dirPath, opts) {
         throw new Error(`Directory ${dirPath} does not exist`);
     }
     const serveFile = (req, res, filePath, stats) => {
+        if (opts.render) {
+            const defaultRenderer = res.FF.getVar("view engine");
+            const renderStatement = (defaultRenderer && filePath.endsWith(ensureLeadingDot(defaultRenderer))) ||
+                (!opts.notRenderHtml && filePath.endsWith(".html"));
+            if (renderStatement) {
+                res.render(filePath, {}, { notUseViews: true });
+                return true;
+            }
+        }
         if (opts.etag) {
             const etag = `W/"${stats.size}-${stats.mtime.getTime()}"`;
             if (req.headers["if-none-match"] === etag) {
@@ -53,11 +62,6 @@ export function handleStaticFiles(dirPath, opts) {
             }
             res.setHeader("ETag", etag);
         }
-        if (opts.render && filePath.endsWith(".html")) {
-            res.ct("text/html");
-            res.render(filePath);
-            return true;
-        }
         res.ct(getContentType(filePath, opts.utf8));
         fs.createReadStream(filePath).pipe(res);
         return true;
@@ -104,3 +108,4 @@ export function handleStaticFiles(dirPath, opts) {
         next();
     };
 }
+export const ensureLeadingDot = (str) => (str.startsWith(".") ? str : "." + str);

package/dist/index.d.ts

@@ -1,11 +1,9 @@
 import { Logger, LoggerOptions } from "@wxn0brp/lucerna-log";
 import http from "http";
-import { PluginSystem } from "./plugin.js";
 import { renderHTML } from "./render.js";
 import { FFResponse } from "./res.js";
 import { Router } from "./router.js";
-import type { BeforeHandleRequest, FFRequest, RouteHandler } from "./types.js";
-export type EngineCallback = (path: string, options: any, callback: (e: any, rendered?: string) => void) => void;
+import type { BeforeHandleRequest, EngineCallback, FFRequest, RouteHandler } from "./types.js";
 export interface Opts {
     loggerOpts?: LoggerOptions;
     bodyLimit?: string;
@@ -34,8 +32,13 @@ export declare class FalconFrame<Vars extends Record<string, any> = any> extends
      * 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.
+     * @param port - The port number to listen to.
+     * @returns The server object returned by the listen method.
+     */
+    l(port: number): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
 }
 export default FalconFrame;
 export * as Helpers from "./helpers.js";
-export * as PluginsEngine from "./plugin.js";
-export { FFRequest, FFResponse, PluginSystem, renderHTML, RouteHandler, Router };
+export { FFRequest, FFResponse, renderHTML, RouteHandler, Router };

package/dist/index.js

@@ -1,12 +1,11 @@
 import { Logger } from "@wxn0brp/lucerna-log";
 import http from "http";
-import { PluginSystem } from "./plugin.js";
-import { createCORSPlugin } from "./plugins/cors.js";
+import { json, urlencoded } from "./body.js";
+import { createCORS } from "./cors.js";
 import { renderHTML } from "./render.js";
 import { handleRequest } from "./req.js";
 import { FFResponse } from "./res.js";
 import { Router } from "./router.js";
-import { json, urlencoded } from "./body.js";
 export class FalconFrame extends Router {
     logger;
     bodyParsers = [];
@@ -89,10 +88,17 @@ export class FalconFrame extends Router {
      * app.setOrigin(["http://example.com", "https://example.com"]);
     */
     setOrigin(origin = "*") {
-        this.use(createCORSPlugin(Array.isArray(origin) ? origin : [origin]).process);
+        this.use(createCORS(Array.isArray(origin) ? origin : [origin]));
+    }
+    /**
+     * Listens to the specified port, or the environment variable PORT if available.
+     * @param port - The port number to listen to.
+     * @returns The server object returned by the listen method.
+     */
+    l(port) {
+        return this.listen(+process.env.PORT || port, true);
     }
 }
 export default FalconFrame;
 export * as Helpers from "./helpers.js";
-export * as PluginsEngine from "./plugin.js";
-export { FFResponse, PluginSystem, renderHTML, Router };
+export { FFResponse, renderHTML, Router };

package/dist/res.d.ts

@@ -1,6 +1,6 @@
 import http from "http";
 import FalconFrame from "./index.js";
-import { CookieOptions } from "./types.js";
+import { CookieOptions, RenderOptions } from "./types.js";
 export declare class FFResponse extends http.ServerResponse {
     _ended: boolean;
     FF: FalconFrame;
@@ -62,7 +62,7 @@ export declare class FFResponse extends http.ServerResponse {
      * @param data An object containing data to be injected into the template.
      * @returns The response object.
      */
-    render(view: string, data?: any): this;
+    render(view: string, data?: any, opts?: RenderOptions): this;
     /**
      * Initialize SSE headers to start a server-sent event stream.
      * Sets:

package/dist/res.js

@@ -1,7 +1,7 @@
 import { createReadStream } from "fs";
 import http from "http";
 import path from "path";
-import { getContentType } from "./helpers.js";
+import { ensureLeadingDot, getContentType } from "./helpers.js";
 export class FFResponse extends http.ServerResponse {
     _ended = false;
     FF;
@@ -104,20 +104,24 @@ export class FFResponse extends http.ServerResponse {
      * @param data An object containing data to be injected into the template.
      * @returns The response object.
      */
-    render(view, data = {}) {
+    render(view, data = {}, opts = {}) {
         const ff = this.FF;
-        const viewEngine = ff.getVar("view engine");
-        const viewsDir = ff.getVar("views") || ".";
-        let finalExt = path.extname(view);
+        const viewsDir = opts.baseDir ??
+            (opts.notUseViews ? "." : (ff.getVar("views") || "."));
+        let engineName = path.extname(view);
         let filePath = view;
-        if (!finalExt) {
-            const defaultExt = viewEngine ? (viewEngine.startsWith(".") ? viewEngine : "." + viewEngine) : ".html";
-            finalExt = defaultExt;
-            filePath += finalExt;
+        if (opts.engine) {
+            engineName = ensureLeadingDot(opts.engine);
         }
-        const engine = ff.engines[finalExt];
+        else if (!engineName) {
+            const defaultEngine = ff.getVar("view engine");
+            engineName = defaultEngine ? ensureLeadingDot(defaultEngine) : ".html";
+            if (!opts.notAppendExt)
+                filePath += engineName;
+        }
+        const engine = ff.engines[engineName];
         if (!engine) {
-            const errMessage = `No engine registered for extension ${finalExt}`;
+            const errMessage = `No engine registered for extension ${engineName}`;
             ff.logger.error(errMessage);
             this.status(500).end("Server Error: " + errMessage);
             return this;
@@ -130,7 +134,7 @@ export class FFResponse extends http.ServerResponse {
                     this.status(500).end("Server Error: Failed to render view.");
                 }
                 else {
-                    this.setHeader("Content-Type", "text/html");
+                    this.ct(opts.contentType || "text/html");
                     this.end(str);
                 }
             });

package/dist/router.d.ts

@@ -1,7 +1,8 @@
-import { PluginSystem } from "./plugin.js";
 import { SSEManager } from "./sse.js";
 import { Method, Middleware, RouteHandler, StaticServeOptions } from "./types.js";
-export type MiddlewareFn = RouteHandler | Router | PluginSystem;
+export type MiddlewareFn = RouteHandler | Router | {
+    getRouteHandler(): RouteHandler;
+};
 export declare class Router {
     middlewares: Middleware[];
     addRoute(method: Method, path: string, ...handlers: RouteHandler[]): number;

package/dist/router.js

@@ -1,5 +1,4 @@
 import { handleStaticFiles } from "./helpers.js";
-import { PluginSystem } from "./plugin.js";
 import { SSEManager } from "./sse.js";
 export class Router {
     middlewares = [];
@@ -9,7 +8,7 @@ export class Router {
         return this.middlewares.push({ path, middleware: handler, method });
     }
     use(path = "/", middlewareFn, method = "all") {
-        if (typeof path === "function" || path instanceof Router || path instanceof PluginSystem) {
+        if (typeof path !== "string") {
             middlewareFn = path;
             path = "/";
         }
@@ -22,7 +21,7 @@ export class Router {
         if (middlewareFn instanceof Router) {
             middleware.router = middlewareFn.middlewares;
         }
-        else if (middlewareFn instanceof PluginSystem) {
+        else if ("getRouteHandler" in middlewareFn) {
             middleware.middleware = middlewareFn.getRouteHandler();
         }
         else {

package/dist/types.d.ts

@@ -59,4 +59,13 @@ export interface StaticServeOptions {
     render?: boolean;
     etag?: boolean;
     errorIfDirNotFound?: boolean;
+    notRenderHtml?: boolean;
+}
+export type EngineCallback = (path: string, options: any, callback: (e: any, rendered?: string) => void) => void;
+export interface RenderOptions {
+    notUseViews?: boolean;
+    contentType?: string;
+    baseDir?: string;
+    engine?: string;
+    notAppendExt?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/falcon-frame",
-  "version": "0.4.1",
+  "version": "0.5.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",

package/dist/plugin.d.ts

@@ -1,54 +0,0 @@
-import { RouteHandler } from "./types.js";
-export type PluginId = string;
-export interface Plugin {
-    id: PluginId;
-    process: RouteHandler;
-    before?: PluginId | PluginId[];
-    after?: PluginId | PluginId[];
-}
-export interface PluginOptions {
-    before?: PluginId | PluginId[];
-    after?: PluginId | PluginId[];
-    optional?: boolean;
-}
-/**
- * @deprecated
- * The `PluginSystem` class is deprecated and should not be used in new projects.
- *
- * ⚠️ Notes:
- * - It may be refactored in the future, but any refactor will introduce breaking changes.
- * - If your system currently relies on it and it works, you may continue using it.
- * - If it does not work in your setup, it is recommended to skip it or wait for an update.
- */
-export declare class PluginSystem {
-    private plugins;
-    private executionOrder;
-    /**
-     * Registers a new plugin in the system
-     * @param plugin - Plugin to register
-     * @param options - Options for positioning plugins
-     */
-    register(plugin: Plugin, options?: PluginOptions): void;
-    /**
-     * Updates the execution order of plugins
-     * @param pluginId - ID of the plugin to position
-     * @param options - Options for positioning
-     */
-    private updateExecutionOrder;
-    /**
-     * Returns a RouteHandler that executes all registered plugins in the correct order
-     */
-    getRouteHandler(): RouteHandler;
-    /**
-     * Recursively executes plugins in the correct order
-     * @param req - Request object
-     * @param res - Response object
-     * @param next - Next function
-     * @param index - Current index in the execution order
-     */
-    private executePlugins;
-    /**
-     * Returns the list of plugins in the execution order
-     */
-    getPluginsInOrder(): Plugin[];
-}

package/dist/plugin.js

@@ -1,101 +0,0 @@
-/**
- * @deprecated
- * The `PluginSystem` class is deprecated and should not be used in new projects.
- *
- * ⚠️ Notes:
- * - It may be refactored in the future, but any refactor will introduce breaking changes.
- * - If your system currently relies on it and it works, you may continue using it.
- * - If it does not work in your setup, it is recommended to skip it or wait for an update.
- */
-export class PluginSystem {
-    plugins = [];
-    executionOrder = [];
-    /**
-     * Registers a new plugin in the system
-     * @param plugin - Plugin to register
-     * @param options - Options for positioning plugins
-     */
-    register(plugin, options) {
-        if (this.plugins.some((p) => p.id === plugin.id)) {
-            throw new Error(`Plugin with id '${plugin.id}' already registered`);
-        }
-        this.plugins.push(plugin);
-        this.updateExecutionOrder(plugin, options);
-    }
-    /**
-     * Updates the execution order of plugins
-     * @param pluginId - ID of the plugin to position
-     * @param options - Options for positioning
-     */
-    updateExecutionOrder(plugin, options) {
-        const pluginId = plugin.id;
-        if (this.executionOrder.includes(pluginId))
-            return;
-        const resolveTarget = (target) => {
-            if (!target)
-                return null;
-            const list = Array.isArray(target) ? target : [target];
-            return list.find((id) => this.executionOrder.includes(id)) || null;
-        };
-        const beforeTarget = resolveTarget(options?.before || plugin.before);
-        const afterTarget = resolveTarget(options?.after || plugin.after);
-        if (beforeTarget) {
-            const index = this.executionOrder.indexOf(beforeTarget);
-            this.executionOrder.splice(index, 0, pluginId);
-        }
-        else if (afterTarget) {
-            const index = this.executionOrder.indexOf(afterTarget);
-            this.executionOrder.splice(index + 1, 0, pluginId);
-        }
-        else if (options?.before || options?.after) {
-            if (options.optional) {
-                this.executionOrder.push(pluginId); // fallback: add to the end
-            }
-            else {
-                throw new Error(`Plugin dependency not found for '${pluginId}': ` +
-                    `before=${JSON.stringify(options?.before)}, ` +
-                    `after=${JSON.stringify(options?.after)}`);
-            }
-        }
-        else {
-            this.executionOrder.push(pluginId);
-        }
-    }
-    /**
-     * Returns a RouteHandler that executes all registered plugins in the correct order
-     */
-    getRouteHandler() {
-        return (req, res, next) => {
-            this.executePlugins(req, res, next, 0);
-        };
-    }
-    /**
-     * Recursively executes plugins in the correct order
-     * @param req - Request object
-     * @param res - Response object
-     * @param next - Next function
-     * @param index - Current index in the execution order
-     */
-    executePlugins(req, res, next, index) {
-        if (index >= this.executionOrder.length) {
-            next();
-            return;
-        }
-        const pluginId = this.executionOrder[index];
-        const plugin = this.plugins.find((p) => p.id === pluginId);
-        if (!plugin) {
-            throw new Error(`Plugin '${pluginId}' not found`);
-        }
-        plugin.process(req, res, () => {
-            this.executePlugins(req, res, next, index + 1);
-        });
-    }
-    /**
-     * Returns the list of plugins in the execution order
-     */
-    getPluginsInOrder() {
-        return this.executionOrder
-            .map((id) => this.plugins.find((p) => p.id === id))
-            .filter((p) => p !== undefined);
-    }
-}

package/dist/plugins/cors.d.ts

@@ -1,8 +0,0 @@
-import { Plugin } from "../plugin.js";
-interface Opts {
-    accessControlAllowMethods?: boolean;
-    accessControlAllowHeaders?: boolean;
-    headers?: Record<string, string>;
-}
-export declare function createCORSPlugin(allowedOrigins: string[], opts?: Opts): Plugin;
-export {};

package/dist/plugins/cors.js

@@ -1,42 +0,0 @@
-function setHeader(res, opts) {
-    if (opts.accessControlAllowMethods)
-        res.setHeader("Access-Control-Allow-Methods", "GET,POST,PUT,DELETE,OPTIONS");
-    if (opts.accessControlAllowHeaders)
-        res.setHeader("Access-Control-Allow-Headers", "Content-Type, Authorization");
-}
-export function createCORSPlugin(allowedOrigins, opts = {}) {
-    opts = {
-        accessControlAllowMethods: true,
-        accessControlAllowHeaders: true,
-        ...opts,
-    };
-    return {
-        id: "cors",
-        process: (req, res, next) => {
-            if (opts.headers) {
-                for (const [key, value] of Object.entries(opts.headers)) {
-                    res.setHeader(key, value);
-                }
-            }
-            if (allowedOrigins.includes("*")) {
-                res.setHeader("Access-Control-Allow-Origin", "*");
-                setHeader(res, opts);
-                if (req.method === "OPTIONS") {
-                    res.statusCode = 204;
-                    return res.end();
-                }
-                return next();
-            }
-            const origin = req.headers.origin;
-            if (origin && allowedOrigins.includes(origin)) {
-                res.setHeader("Access-Control-Allow-Origin", origin);
-                setHeader(res, opts);
-                if (req.method === "OPTIONS") {
-                    res.statusCode = 204;
-                    return res.end();
-                }
-            }
-            next();
-        },
-    };
-}

package/dist/plugins/rateLimit.d.ts

@@ -1,2 +0,0 @@
-import { Plugin } from "../plugin.js";
-export declare function createRateLimiterPlugin(maxRequests: number, windowMs: number): Plugin;

package/dist/plugins/rateLimit.js

@@ -1,23 +0,0 @@
-export function createRateLimiterPlugin(maxRequests, windowMs) {
-    const rateLimitMap = new Map();
-    return {
-        id: "rateLimiter",
-        process: (req, res, next) => {
-            const ip = req.socket.remoteAddress ?? "unknown";
-            const now = Date.now();
-            const record = rateLimitMap.get(ip);
-            if (!record || now - record.lastRequest > windowMs) {
-                rateLimitMap.set(ip, { count: 1, lastRequest: now });
-                return next();
-            }
-            if (record.count >= maxRequests) {
-                res.statusCode = 429;
-                return res.end("Too Many Requests");
-            }
-            record.count++;
-            record.lastRequest = now;
-            rateLimitMap.set(ip, record);
-            next();
-        },
-    };
-}

package/dist/plugins/security.d.ts

@@ -1,2 +0,0 @@
-import { Plugin } from "../plugin.js";
-export declare function createSecurityPlugin(): Plugin;

package/dist/plugins/security.js

@@ -1,14 +0,0 @@
-export function createSecurityPlugin() {
-    return {
-        id: "security",
-        process: (req, res, next) => {
-            res.setHeader("X-Content-Type-Options", "nosniff");
-            res.setHeader("X-Frame-Options", "SAMEORIGIN");
-            res.setHeader("Referrer-Policy", "no-referrer");
-            res.setHeader("X-XSS-Protection", "1; mode=block");
-            res.setHeader("Strict-Transport-Security", "max-age=31536000; includeSubDomains");
-            next();
-        },
-        after: "cors",
-    };
-}