@wxn0brp/falcon-frame 0.3.0 → 0.4.1

package/dist/index.d.ts

@@ -29,11 +29,11 @@ export declare class FalconFrame<Vars extends Record<string, any> = any> extends
      * Sets the allowed origins for CORS.
      * This method is a shortcut that simplifies CORS configuration
      * without needing to manually create and register a plugin.
-     * @param origin - An array of allowed origins.
+     * @param [origin] - An array of allowed origins. (default: ["*"])
      * @example
      * app.setOrigin(["http://example.com", "https://example.com"]);
     */
-    setOrigin(origin: string[]): void;
+    setOrigin(origin?: string[] | string): void;
 }
 export default FalconFrame;
 export * as Helpers from "./helpers.js";

package/dist/index.js

@@ -84,12 +84,12 @@ export class FalconFrame extends Router {
      * Sets the allowed origins for CORS.
      * This method is a shortcut that simplifies CORS configuration
      * without needing to manually create and register a plugin.
-     * @param origin - An array of allowed origins.
+     * @param [origin] - An array of allowed origins. (default: ["*"])
      * @example
      * app.setOrigin(["http://example.com", "https://example.com"]);
     */
-    setOrigin(origin) {
-        this.use(createCORSPlugin(origin).process);
+    setOrigin(origin = "*") {
+        this.use(createCORSPlugin(Array.isArray(origin) ? origin : [origin]).process);
     }
 }
 export default FalconFrame;

package/dist/plugin.d.ts

@@ -11,6 +11,15 @@ export interface PluginOptions {
     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;

package/dist/plugin.js

@@ -1,3 +1,12 @@
+/**
+ * @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 = [];

package/dist/render.d.ts

@@ -1,5 +1,6 @@
+import FalconFrame from "./index.js";
 interface RenderData {
     [key: string]: string;
 }
-export declare function renderHTML(templatePath: string, data: RenderData, renderedPaths?: string[]): string;
+export declare function renderHTML(templatePath: string, data: RenderData, renderedPaths?: string[], FF?: FalconFrame): string;
 export {};

package/dist/render.js

@@ -1,6 +1,6 @@
 import fs from "fs";
 import path from "path";
-export function renderHTML(templatePath, data, renderedPaths = []) {
+export function renderHTML(templatePath, data, renderedPaths = [], FF) {
     try {
         const realPath = path.resolve(templatePath);
         if (renderedPaths.includes(realPath)) {
@@ -17,6 +17,17 @@ export function renderHTML(templatePath, data, renderedPaths = []) {
                 realPath,
             ]);
         });
+        // Layout
+        if (FF && FF.vars["layout"]) {
+            const hasHtmlStructure = /<\s*html|<\s*body/i.test(template);
+            const forceLayout = /<!--\s*force-layout\s*-->/.test(template);
+            const forceNoLayout = /<!--\s*force-no-layout\s*-->/.test(template);
+            if (hasHtmlStructure && !forceLayout)
+                return template;
+            if (!hasHtmlStructure && forceNoLayout)
+                return template;
+            return renderHTML(FF.vars["layout"], { ...data, body: template }, [...renderedPaths, realPath]);
+        }
         return template;
     }
     catch (error) {

package/dist/req.js

@@ -72,6 +72,7 @@ export function handleRequest(req, res, FF) {
     }
     const hasCustomParserEndpoint = matchedMiddlewares.some(middleware => middleware.customParser);
     if (hasCustomParserEndpoint) {
+        logger.debug("Executing custom parser endpoint");
         req.body = {};
         next();
         return;
@@ -79,6 +80,7 @@ export function handleRequest(req, res, FF) {
     if (req.method === "GET" ||
         req.method === "HEAD" ||
         req.method === "OPTIONS") {
+        logger.debug("Method does not require body. Executing middlewares");
         req.body = {};
         next();
         return;

package/dist/router.d.ts

@@ -1,4 +1,5 @@
 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 declare class Router {
@@ -11,6 +12,7 @@ export declare class Router {
     delete(path: string, ...handlers: RouteHandler[]): this;
     all(path: string, ...handlers: RouteHandler[]): this;
     static(apiPath: string, dirPath?: string, opts?: StaticServeOptions): this;
-    sse(path: string, ...handlers: RouteHandler[]): this;
+    sse(path: string, ...handlers: RouteHandler[]): SSEManager;
     customParser(path: string, handler: RouteHandler, method?: Method): this;
+    router(path: string): Router;
 }

package/dist/router.js

@@ -1,5 +1,6 @@
 import { handleStaticFiles } from "./helpers.js";
 import { PluginSystem } from "./plugin.js";
+import { SSEManager } from "./sse.js";
 export class Router {
     middlewares = [];
     addRoute(method, path, ...handlers) {
@@ -59,13 +60,20 @@ export class Router {
         return this;
     }
     sse(path, ...handlers) {
-        const index = this.addRoute("get", path, ...handlers);
-        this.middlewares[index - 1].sse = true;
-        return this;
+        const lastHandler = handlers.pop() || (() => { });
+        const manager = new SSEManager();
+        handlers.push(manager.getMiddleware(lastHandler));
+        this.addRoute("get", path, ...handlers);
+        return manager;
     }
     customParser(path, handler, method = "post") {
         const index = this.addRoute(method, path, handler);
         this.middlewares[index - 1].customParser = true;
         return this;
     }
+    router(path) {
+        const router = new Router();
+        this.use(path, router);
+        return router;
+    }
 }

package/dist/sse.d.ts

@@ -0,0 +1,13 @@
+import type { FFRequest, RouteHandler } from "./types.js";
+import { FFResponse } from "./res.js";
+export declare class SSEManager {
+    private clients;
+    getMiddleware(lastHandler?: RouteHandler): RouteHandler;
+    getClients(): Map<string, {
+        req: FFRequest;
+        res: FFResponse;
+    }>;
+    sendAll(data: any): void;
+    sendTo(id: string, data: any): void;
+    disconnect(id: string): void;
+}

package/dist/sse.js

@@ -0,0 +1,37 @@
+import { randomUUID } from "crypto";
+export class SSEManager {
+    clients = new Map();
+    getMiddleware(lastHandler) {
+        return (req, res, next) => {
+            res.sseInit();
+            const id = randomUUID();
+            this.clients.set(id, { req, res });
+            req.on("close", () => {
+                this.clients.delete(id);
+            });
+            req.sseId = id;
+            lastHandler?.(req, res, next);
+        };
+    }
+    getClients() {
+        return this.clients;
+    }
+    sendAll(data) {
+        for (const { res } of this.clients.values()) {
+            res.sseSend(data);
+        }
+    }
+    sendTo(id, data) {
+        const client = this.clients.get(id);
+        if (client) {
+            client.res.sseSend(data);
+        }
+    }
+    disconnect(id) {
+        const client = this.clients.get(id);
+        if (client) {
+            client.res.end();
+            this.clients.delete(id);
+        }
+    }
+}

package/dist/types.d.ts

@@ -27,6 +27,7 @@ export declare class FFRequest extends http.IncomingMessage {
     body: Body;
     valid: (schema: ValidationSchema) => ValidationResult;
     middleware: Middleware;
+    sseId?: string;
 }
 export interface Middleware {
     path: string;
@@ -34,7 +35,6 @@ export interface Middleware {
     middleware: RouteHandler;
     use?: true;
     router?: Middleware[];
-    sse?: true;
     customParser?: true;
 }
 export interface CookieOptions {

package/dist/types.js

@@ -7,4 +7,5 @@ export class FFRequest extends http.IncomingMessage {
     body;
     valid;
     middleware;
+    sseId;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/falcon-frame",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -34,4 +34,4 @@
       "import": "./dist/*.js"
     }
   }
-}
+}