npm - @wxn0brp/falcon-frame - Versions diffs - 0.0.2 → 0.0.3 - Mend

@wxn0brp/falcon-frame 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

package/README.md +1 -1
package/package.json +4 -1
package/.github/workflows/build.yml +0 -20
package/CHANGELOG.md +0 -18
package/public/index.html +0 -47
package/public/style.css +0 -41
package/src/helpers.ts +0 -79
package/src/index.ts +0 -87
package/src/req.ts +0 -123
package/src/res.ts +0 -43
package/src/test.ts +0 -68
package/src/types.ts +0 -56
package/src/valid.ts +0 -62
package/suglite.json +0 -10
package/tsconfig.json +0 -22

package/README.md CHANGED Viewed

@@ -20,7 +20,7 @@
 ## 📦 Installation
 ```bash
-yarn add github:wxn0brP/FalconFrame#dist
+yarn add @wxn0brp/falcon-frame
 ```
 ## 🚦 Usage Example

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/falcon-frame",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -14,6 +14,9 @@
   "dependencies": {
     "@wxn0brp/wts-logger": "github:wxn0brP/ts-shared#dist-logger"
   },
+  "files": [
+    "dist"
+  ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",

package/.github/workflows/build.yml DELETED Viewed

@@ -1,20 +0,0 @@
-name: Build
-on:
-  push:
-    branches:
-      - master
-    tags:
-      - "*"
-  workflow_dispatch:
-jobs:
-  build:
-    uses: wxn0brP/workflow-dist/.github/workflows/build-ts.yml@main
-    with:
-      scriptsHandling: "remove-all"
-      publishToNpm: true
-    secrets:
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md DELETED Viewed

@@ -1,18 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-### 0.0.2 (2025-05-15)
-### Features
-* add alternative export ([4e69a6b](https://github.com/wxn0brP/FalconFrame/commit/4e69a6b0fa771c35d9aef2270174cba3026251c3))
-* add build workflow ([d89bd23](https://github.com/wxn0brP/FalconFrame/commit/d89bd2385a4e5855cfa4205c86563ba65f89c978))
-* add simple valid function ([8c247d2](https://github.com/wxn0brP/FalconFrame/commit/8c247d2610c78c748fca4efc25840b51359e9490))
-* add type export ([0ef9d6c](https://github.com/wxn0brP/FalconFrame/commit/0ef9d6cd61221c88c79f25b07b3240bec379ca76))
-* enhance middlewares ([3c2063b](https://github.com/wxn0brP/FalconFrame/commit/3c2063b6366514b55e2ac19a83b1dba9d42072cb))
-* make public ([63b38fc](https://github.com/wxn0brP/FalconFrame/commit/63b38fc5fdfbacef9e2e9be2c4ffd0d66553443c))
-* refactor engine ([d2a40c4](https://github.com/wxn0brP/FalconFrame/commit/d2a40c471195ea8a0bfdbfd5edeebc2dcd4a438d))
-* return server on listen ([f98e6c9](https://github.com/wxn0brP/FalconFrame/commit/f98e6c931e0afd4b5627b363707d0bf3460b5770))
-* update exports ([2feac36](https://github.com/wxn0brP/FalconFrame/commit/2feac36f12de6e06f1d023d5964eefe271c49f4f))

package/public/index.html DELETED Viewed

@@ -1,47 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Yep</title>
-    <link rel="stylesheet" href="style.css">
-</head>
-<body>
-    <h1>
-        Work
-    </h1>
-    <br>
-    <form>
-        <label>
-            Login
-            <input type="text" name="login">
-        </label>
-        <label>
-            Password
-            <input type="password" name="password">
-        </label>
-        <button type="submit">Submit</button>
-    </form>
-    <script type="module">
-        const form = document.querySelector("form");
-        form.addEventListener("submit", async e => {
-            e.preventDefault();
-            const formData = new FormData(form);
-            const data = Object.fromEntries(formData);
-            const response = await fetch("/submit", {
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json"
-                },
-                body: JSON.stringify(data)
-            });
-            const result = await response.json();
-            console.log(result);
-            alert(JSON.stringify(result, null, 2));
-        });
-    </script>
-</body>
-</html>

package/public/style.css DELETED Viewed

@@ -1,41 +0,0 @@
-*{
-    margin: 0;
-    padding: 0;
-    box-sizing: border-box;
-}
-body{
-    background-color: #181818;
-    color: #c9d6de;
-    text-align: center;
-    font-family: Verdana, Geneva, Tahoma, sans-serif
-}
-h1 {
-    color: rebeccapurple;
-}
-form {
-    display: flex;
-    flex-direction: column;
-    width: 300px;
-    border: 1px solid rebeccapurple;
-    padding: 1rem;
-    border-radius: 0.75rem;
-    margin-inline: auto;
-}
-form label {
-    margin: 0.5rem 0;
-}
-form button {
-    margin-top: 1rem;
-    padding: 0.5rem 1rem;
-    background-color: rebeccapurple;
-    color: white;
-    border: none;
-    border-radius: 0.25rem;
-    cursor: pointer;
-}

package/src/helpers.ts DELETED Viewed

@@ -1,79 +0,0 @@
-import fs from "fs";
-import path from "path";
-import querystring from "querystring";
-import { FFResponse } from "./res";
-import { Body, Cookies, FFRequest, RouteHandler } from "./types";
-export function parseCookies(cookieHeader: string): Cookies {
-    const cookies: Cookies = {};
-    cookieHeader.split(";").forEach(cookie => {
-        const [name, ...valueParts] = cookie.split("=");
-        const value = decodeURIComponent(valueParts.join("=").trim());
-        cookies[name.trim()] = value;
-    });
-    return cookies;
-}
-export function parseBody(contentType: string, body: string): Body {
-    if (contentType.includes("application/json")) {
-        try {
-            return JSON.parse(body);
-        } catch {
-            return {};
-        }
-    } else if (contentType.includes("application/x-www-form-urlencoded")) {
-        return querystring.parse(body);
-    }
-    return {};
-}
-export function getContentType(filePath: string): string {
-    const ext = path.extname(filePath).toLowerCase();
-    switch (ext) {
-        case ".html":
-            return "text/html";
-        case ".css":
-            return "text/css";
-        case ".js":
-            return "application/javascript";
-        case ".json":
-            return "application/json";
-        case ".png":
-            return "image/png";
-        case ".jpg":
-        case ".jpeg":
-            return "image/jpeg";
-        case ".gif":
-            return "image/gif";
-        case ".svg":
-            return "image/svg+xml";
-        default:
-            return "application/octet-stream";
-    }
-}
-export function handleStaticFiles(apiPath: string, dirPath: string): RouteHandler {
-    return (req: FFRequest, res: FFResponse, next: () => void) => {
-        if (!req.path.startsWith(apiPath)) return next();
-        const filePath = path.join(dirPath, req.path.slice(apiPath.length));
-        if (fs.existsSync(filePath) && fs.statSync(filePath).isFile()) {
-            res.setHeader("Content-Type", getContentType(filePath));
-            fs.createReadStream(filePath).pipe(res);
-            return true;
-        }
-        if (req.path.endsWith("/")) {
-            if (fs.existsSync(filePath) && fs.statSync(filePath).isDirectory()) {
-                const indexPath = path.join(filePath, "index.html");
-                if (fs.existsSync(indexPath) && fs.statSync(indexPath).isFile()) {
-                    res.setHeader("Content-Type", getContentType(indexPath));
-                    fs.createReadStream(indexPath).pipe(res);
-                    return true;
-                }
-            }
-        }
-        next();
-    }
-}

package/src/index.ts DELETED Viewed

@@ -1,87 +0,0 @@
-import { Logger, LoggerOptions } from "@wxn0brp/wts-logger";
-import http from "http";
-import { handleStaticFiles } from "./helpers";
-import { handleRequest } from "./req";
-import { FFResponse } from "./res";
-import { FFRequest, Method, Middleware, RouteHandler } from "./types";
-export class FalconFrame {
-    public middlewares: Middleware[] = [];
-    public logger: Logger;
-    constructor(loggerOpts?: LoggerOptions) {
-        this.logger = new Logger({
-            loggerName: "falcon-frame",
-            ...loggerOpts
-        });
-    }
-    addRoute(method: Method, path: string, ...handlers: RouteHandler[]): void {
-        const handler = handlers.pop();
-        handlers.forEach(middleware => this.use(path, middleware));
-        this.middlewares.push({ path, middleware: handler, method });
-    }
-    use(path: string | RouteHandler = "/", middleware?: RouteHandler, method: Method = "all"): void {
-        if (typeof path === "function") {
-            middleware = path;
-            path = "/";
-        }
-        this.middlewares.push({ path, middleware, method, use: true });
-    }
-    get(path: string, ...handlers: RouteHandler[]): void {
-        this.addRoute("get", path, ...handlers);
-    }
-    post(path: string, ...handlers: RouteHandler[]): void {
-        this.addRoute("post", path, ...handlers);
-    }
-    put(path: string, ...handlers: RouteHandler[]): void {
-        this.addRoute("put", path, ...handlers);
-    }
-    delete(path: string, ...handlers: RouteHandler[]): void {
-        this.addRoute("delete", path, ...handlers);
-    }
-    all(path: string, ...handlers: RouteHandler[]): void {
-        this.addRoute("all", path, ...handlers);
-    }
-    static(apiPath: string, dirPath: string): void {
-        this.middlewares.push({
-            path: (apiPath+"/*").replace("//","/"),
-            method: "get",
-            middleware: handleStaticFiles(apiPath, dirPath)
-        });
-        this.middlewares.push({
-            path: apiPath,
-            method: "get",
-            middleware: handleStaticFiles(apiPath, dirPath)
-        });
-    }
-    listen(port: number, callback?: () => void) {
-        const server = http.createServer((req, res) => {
-            handleRequest(req as FFRequest, res as FFResponse, this);
-        });
-        server.listen(port, callback);
-        return server;
-    }
-    getApp() {
-        return (req: any, res: any) => {
-            handleRequest(req as FFRequest, res as FFResponse, this);
-        }
-    }
-}
-export default FalconFrame;
-export {
-    FFResponse,
-    FFRequest,
-    RouteHandler,
-}

package/src/req.ts DELETED Viewed

@@ -1,123 +0,0 @@
-import { URL } from "url";
-import FalconFrame from ".";
-import { parseBody, parseCookies } from "./helpers";
-import { FFResponse } from "./res";
-import { FFRequest, Middleware } from "./types";
-import { validate } from "./valid";
-export function handleRequest(req: FFRequest, res: FFResponse, FF: FalconFrame): void {
-    Object.setPrototypeOf(res, FFResponse.prototype);
-    const originalEnd = res.end;
-    res.end = function (...any: any[]) {
-        res._ended = true;
-        return originalEnd.call(res, ...any);
-    }
-    const { logger, middlewares } = FF;
-    const parsedUrl = new URL(req.url || "", "http://localhost");
-    req.path = parsedUrl.pathname || "/";
-    req.query = Object.fromEntries(parsedUrl.searchParams);
-    req.cookies = parseCookies(req.headers.cookie || "");
-    req.params = {};
-    req.valid = (schema: any) => validate(schema, req.body);
-    logger.info(`Incoming request: ${req.method} ${req.url}`);
-    let body = "";
-    req.on("data", chunk => (body += chunk.toString()));
-    req.on("end", () => {
-        const contentType = req.headers["content-type"] || "";
-        req.body = parseBody(contentType, body);
-        logger.debug(`Request body: ${JSON.stringify(req.body)}`);
-        const matchedTypeMiddlewares = middlewares.filter(middleware => middleware.method === req.method.toLocaleLowerCase() || middleware.method === "all");
-        const matchedMiddlewares = matchMiddleware(req.path, matchedTypeMiddlewares);
-        if (matchedMiddlewares.length === 0) {
-            return res.status(404).end("404: File had second thoughts.");
-        }
-        logger.debug("Matched middlewares: " + matchedMiddlewares.map(middleware => middleware.path).join(", "));
-        let middlewareIndex = 0;
-        const next = async () => {
-            if (middlewareIndex >= matchedMiddlewares.length) {
-                return res.status(404).end("404: File had second thoughts");
-            }
-            const middleware = matchedMiddlewares[middlewareIndex++];
-            logger.debug(`Executing middleware ${middlewareIndex} of ${matchedMiddlewares.length} matched for path [${middleware.path}]`);
-            if (middleware.path.includes(":")) {
-                const middlewareParts = middleware.path.split("/");
-                const reqPathParts = req.path.split("/");
-                req.params = {};
-                for (let i = 0; i < middlewareParts.length; i++) {
-                    if (middlewareParts[i].startsWith(":")) {
-                        const paramName = middlewareParts[i].slice(1);
-                        req.params[paramName] = reqPathParts[i];
-                    }
-                }
-            }
-            const result = await middleware.middleware(req, res, next);
-            if (result && !res._ended) {
-                if (typeof result === "string") {
-                    return res.end(result);
-                } else if (typeof result === "object") {
-                    return res.json(result);
-                }
-            }
-        }
-        next();
-    });
-}
-function matchMiddleware(url: string, middlewares: Middleware[]): Middleware[] {
-    const matchedMiddlewares: Middleware[] = [];
-    url = url.replace(/\/$/, "");
-    for (const middleware of middlewares) {
-        const cleanedMiddleware = middleware.path.replace(/\/$/, "");
-        if (middleware.use) {
-            if (url.startsWith(cleanedMiddleware)) {
-                matchedMiddlewares.push(middleware);
-            }
-        } else if (cleanedMiddleware === "*") {
-            matchedMiddlewares.push(middleware);
-        } else if (cleanedMiddleware.endsWith("/*")) {
-            const prefix = cleanedMiddleware.slice(0, -2);
-            if (url.startsWith(prefix)) {
-                matchedMiddlewares.push(middleware);
-            }
-        } else if (cleanedMiddleware.includes(":")) {
-            const middlewareParts = cleanedMiddleware.split("/");
-            const urlParts = url.split("/");
-            if (middlewareParts.length !== urlParts.length) {
-                continue;
-            }
-            let matches = true;
-            for (let i = 0; i < middlewareParts.length; i++) {
-                if (middlewareParts[i].startsWith(":")) {
-                    continue;
-                } else if (middlewareParts[i] !== urlParts[i]) {
-                    matches = false;
-                    break;
-                }
-            }
-            if (matches) {
-                matchedMiddlewares.push(middleware);
-            }
-        } else {
-            if (url === cleanedMiddleware) {
-                matchedMiddlewares.push(middleware);
-            }
-        }
-    }
-    return matchedMiddlewares;
-}

package/src/res.ts DELETED Viewed

@@ -1,43 +0,0 @@
-import http from "http";
-import { CookieOptions } from "./types";
-import { getContentType } from "./helpers";
-import { createReadStream } from "fs";
-export class FFResponse extends http.ServerResponse {
-    _ended = false;
-    json(data: any): void {
-        this.setHeader("Content-Type", "application/json");
-        this.end(JSON.stringify(data));
-    }
-    cookie(name: string, value: string, options: CookieOptions = {}): this {
-        let cookie = `${name}=${encodeURIComponent(value)}`;
-        if (options.maxAge) cookie += `; Max-Age=${options.maxAge}`;
-        if (options.path) cookie += `; Path=${options.path}`;
-        if (options.httpOnly) cookie += `; HttpOnly`;
-        if (options.secure) cookie += `; Secure`;
-        if (options.sameSite) cookie += `; SameSite=${options.sameSite}`;
-        this.setHeader("Set-Cookie", cookie);
-        return this;
-    }
-    status(code: number): this {
-        this.statusCode = code;
-        return this;
-    }
-    redirect(url: string): this {
-        this.statusCode = 302;
-        this.setHeader("Location", url);
-        return this;
-    }
-    sendFile(filePath: string): this {
-        this.setHeader("Content-Type", getContentType(filePath));
-        createReadStream(filePath).pipe(this);
-        return this;
-    }
-}

package/src/test.ts DELETED Viewed

@@ -1,68 +0,0 @@
-import FalconFrame from ".";
-const app = new FalconFrame({
-    logLevel: "INFO",
-});
-app.use((req, res, next) => {
-    console.log(`[${req.method}] ${req.path}`);
-    next();
-});
-app.static("/", "public");
-app.get("/hello", (req, res) => {
-    const name = req.query.name || "World";
-    res.json({
-        message: `Hello, ${name}?`,
-        query: req.query,
-    });
-});
-app.get("/hello/*", (req, res) => {
-    res.json({
-        message: `Hello, ${req.params.name}!`,
-        query: req.query,
-    });
-});
-app.get("/greet/:name", (req, res, next) => {
-    console.log(req.params);
-    next();
-}, (req, res) => {
-    res.json({
-        message: `Hello, ${req.params.name}!`,
-    });
-})
-app.post("/submit", (req, res, next) => {
-    const { validErrors, valid } = req.valid({
-        login: "required|string",
-        password: "required|string|min:8",
-    });
-    if (!valid) {
-        res.status(400).json({
-            status: "error",
-            errors: validErrors,
-        });
-    } else next()
-}, async (req, res) => {
-    console.log("run")
-    res.redirect("/hello?name=" + req.body.login);
-    return {
-        status: "success",
-        data: `Hello ${req.body.login}`,
-    }
-});
-app.use((req, res) => {
-    res.status(404);
-    res.json({
-        message: "Not found",
-    });
-});
-app.listen(3000, () => {
-    console.log("Server running on http://localhost:3000");
-});

package/src/types.ts DELETED Viewed

@@ -1,56 +0,0 @@
-import { FFResponse } from "./res";
-import http from "http";
-export type RouteHandler = (req: FFRequest, res: FFResponse, next?: () => void) => void | any;
-export type Method = "get" | "post" | "put" | "delete" | "all";
-export interface Params {
-    [key: string]: string;
-}
-export interface Cookies {
-    [key: string]: string;
-}
-export interface Query {
-    [key: string]: string | string[];
-}
-export interface Body {
-    [key: string]: any;
-}
-export class FFRequest extends http.IncomingMessage {
-    path!: string;
-    query!: Query;
-    params!: Params;
-    cookies!: Cookies;
-    body!: Body;
-    valid!: (schema: ValidationSchema) => ValidationResult;
-}
-export interface Middleware {
-    path: string;
-    method: Method;
-    middleware: RouteHandler;
-    use?: true;
-}
-export interface CookieOptions {
-    maxAge?: number;
-    path?: string;
-    httpOnly?: boolean;
-    secure?: boolean;
-    sameSite?: "Strict" | "Lax" | "None";
-}
-export interface ValidationSchema {
-    [key: string]: string;
-}
-export interface ValidationResult {
-    valid: boolean;
-    validErrors: {
-        [key: string]: string[];
-    };
-}

package/src/valid.ts DELETED Viewed

@@ -1,62 +0,0 @@
-import { ValidationResult, ValidationSchema } from "./types";
-export function validate(schema: ValidationSchema, data: any): ValidationResult {
-    const errors: any = {};
-    let isValid = true;
-    for (const key in schema) {
-        const rules = schema[key].split("|");
-        const value = data[key];
-        const fieldErrors: string[] = [];
-        for (const rule of rules) {
-            const [ruleName, param] = rule.split(":");
-            switch(ruleName) {
-                case "required":
-                    if (!value && value !== 0) {
-                        fieldErrors.push(`${key} is required`);
-                    }
-                    break;
-                case "string":
-                    if (typeof value !== "string") {
-                        fieldErrors.push(`${key} must be a string`);
-                    }
-                    break;
-                case "number":
-                    if (typeof value !== "number") {
-                        fieldErrors.push(`${key} must be a number`);
-                    }
-                    break;
-                case "min":
-                    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)) {
-                        fieldErrors.push(`${key} must be at least ${param}`);
-                    }
-                    break;
-                case "max":
-                    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":
-                    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
-                    if (!emailRegex.test(value)) {
-                        fieldErrors.push(`${key} must be a valid email`);
-                    }
-                    break;
-            }
-        }
-        if (fieldErrors.length > 0) {
-            isValid = false;
-            errors[key] = fieldErrors;
-        }
-    }
-    return { valid: isValid, validErrors: errors };
-}

package/suglite.json DELETED Viewed

@@ -1,10 +0,0 @@
-{
-    "cmd": "yarn build",
-    "watch": [
-        "src"
-    ],
-    "restart_cmd": "clear",
-    "events": {
-        "rs": "clear"
-    }
-}

package/tsconfig.json DELETED Viewed

@@ -1,22 +0,0 @@
-{
-    "compilerOptions": {
-        "module": "ES2022",
-        "target": "ES2022",
-        "moduleResolution": "node",
-        "paths": {},
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "outDir": "./dist",
-        "declaration": true
-    },
-    "include": [
-       "./src"
-    ],
-    "exclude": [
-        "node_modules"
-    ],
-    "tsc-alias": {
-        "resolveFullPaths": true,
-        "verbose": false
-    }
-}