skyguard-js 1.0.0 → 1.0.2

package/README.md

@@ -10,24 +10,24 @@ At its current stage, the framework focuses on **routing**, **internal architect
 
 ## 🎯 Current Goals
 
-* Provide a simple and expressive API to register and handle HTTP routes
-* Maintain a clean, extensible, and framework-agnostic architecture
-* Leverage TypeScript for strong typing and better developer experience
-* Serve as a learning project with progressive evolution
+- Provide a simple and expressive API to register and handle HTTP routes
+- Maintain a clean, extensible, and framework-agnostic architecture
+- Leverage TypeScript for strong typing and better developer experience
+- Serve as a learning project with progressive evolution
 
 ---
 
 ## ✨ Current Features
 
-* TypeScript-first design
-* HTTP routing by method (GET, POST, PUT, PATCH, DELETE)
-* Route groups with prefixes
-* Global, group, and route-level middlewares
-* Request / Response abstractions
-* Declarative data validation
-* Simple template engine with layouts and helpers
-* Static file serving
-* Session handling (via middleware)
+- TypeScript-first design
+- HTTP routing by method (GET, POST, PUT, PATCH, DELETE)
+- Route groups with prefixes
+- Global, group, and route-level middlewares
+- Request / Response abstractions
+- Declarative data validation
+- Simple template engine with layouts and helpers
+- Static file serving
+- Session handling (via middleware)
 
 ---
 
@@ -42,8 +42,7 @@ npm install skyguard-js
 ## 🏁 Basic Usage
 
 ```ts
-import { createApp } from "skyguard-js";
-import { Response } from "skyguard-js/http";
+import { createApp, Response } from "skyguard-js";
 
 const app = createApp();
 
@@ -51,7 +50,9 @@ app.get("/health", () => {
   return Response.json({ status: "ok" });
 });
 
-app.listen(3000);
+app.run(3000, () => {
+  console.log(`Server running in port: http://localhost:${3000}`);
+});
 ```
 
 ---
@@ -79,7 +80,7 @@ Internally, the framework maps HTTP methods to route layers using an optimized r
 Route groups allow you to organize endpoints under a shared prefix.
 
 ```ts
-app.group("/api", (api) => {
+app.group("/api", api => {
   api.get("/users", () => Response.json({ message: "Users" }));
   api.get("/products", () => Response.json({ message: "Products" }));
 });
@@ -92,8 +93,7 @@ app.group("/api", (api) => {
 Middlewares can be registered **globally**, **per group**, or **per route**.
 
 ```ts
-import { Request, Response } from "skyguard-js/http";
-import { RouteHandler } from "skyguard-js/types";
+import { Request, Response, RouteHandler } from "skyguard-js";
 
 const authMiddleware = async (
   request: Request,
@@ -110,17 +110,25 @@ const authMiddleware = async (
 app.middlewares([authMiddleware]);
 
 // Group middleware
-app.group("/admin", (admin) => {
+app.group("/admin", admin => {
   admin.middlewares([authMiddleware]);
   admin.get("/dashboard", () => Response.json({ ok: true }));
 });
 
 // Route-level middleware
-app.get(
-  "/secure",
-  () => Response.json({ secure: true }),
-  [authMiddleware],
-);
+app.get("/secure", () => Response.json({ secure: true }), [authMiddleware]);
+```
+
+---
+
+## Static Files
+
+To serve static files, use the `static` method.
+
+```ts
+import { join } from "node:path";
+
+app.static(join(__dirname, "..", "static"));
 ```
 
 ---
@@ -134,15 +142,15 @@ import { ValidationSchema } from "skyguard-js/validation";
 
 export const userSchema = ValidationSchema.create()
   .field("name")
-    .required("Name is required")
-    .string({ maxLength: 60 })
+  .required("Name is required")
+  .string({ maxLength: 60 })
   .field("email")
-    .required()
-    .email()
+  .required()
+  .email()
   .field("age")
-    .number({ min: 18, max: 99 })
+  .number({ min: 18, max: 99 })
   .field("active")
-    .boolean()
+  .boolean()
   .build();
 
 app.post("/users", (request: Request) => {
@@ -157,10 +165,10 @@ app.post("/users", (request: Request) => {
 
 Validation is:
 
-* Fail-fast per field
-* Fully typed
-* Reusable
-* Decoupled from transport layer
+- Fail-fast per field
+- Fully typed
+- Reusable
+- Decoupled from transport layer
 
 ---
 
@@ -189,13 +197,13 @@ app.get("/home", () => {
 
 ### Supported features
 
-* Variable interpolation (`{{ variable }}`)
-* Conditionals (`{{#if}}`)
-* Loops (`{{#each}}`)
-* Layouts
-* Partials
-* Built-in helpers (`upper`, `lower`, `date`)
-* Custom helpers
+- Variable interpolation (`{{ variable }}`)
+- Conditionals (`{{#if}}`)
+- Loops (`{{#each}}`)
+- Layouts
+- Partials
+- Built-in helpers (`upper`, `lower`, `date`)
+- Custom helpers
 
 ---
 
@@ -203,24 +211,23 @@ app.get("/home", () => {
 
 ⚠️ **Early-stage project**
 
-* Not production-ready
-* API may change
-* Features are still evolving
-* Intended primarily for learning and experimentation
+- Not production-ready
+- API may change
+- Features are still evolving
+- Intended primarily for learning and experimentation
 
 ---
 
 ## 🔮 Roadmap (Tentative)
 
-* Middleware system (✅)
-* Template engine (✅)
-* Request / Response abstraction (✅)
-* Data validation (✅)
-* Error handling improvements
-* Database & ORM integration
-* Authentication & authorization
-* Sessions & cookies (in progress)
-* Plugin system
+- Middleware system (✅)
+- Template engine (✅)
+- Request / Response abstraction (✅)
+- Data validation (✅)
+- Error handling improvements (✅)
+- Sessions & cookies (in progress)
+- Authentication & authorization
+- Database & ORM integration
 
 ---
 
@@ -234,4 +241,4 @@ This project was created to deeply understand how frameworks like **Express**, *
 
 MIT License
 
----
+---

package/dist/app.d.ts

@@ -1,5 +1,4 @@
 import { RouterGroup } from "./routing";
-import { type HttpAdapter } from "./http";
 import { type View } from "./views";
 import type { Middleware, RouteHandler } from "./types";
 /**
@@ -23,8 +22,6 @@ import type { Middleware, RouteHandler } from "./types";
 export declare class App {
     /** Main routing system */
     private router;
-    /** Underlying HTTP server implementation */
-    private server;
     /**
      * View engine used to render templates.
      *
@@ -57,7 +54,7 @@ export declare class App {
      *
      * @param adapter - HTTP adapter bridging the runtime with the framework
      */
-    handle(adapter: HttpAdapter): Promise<void>;
+    private handle;
     /**
      * Enables static file serving.
      *
@@ -76,7 +73,7 @@ export declare class App {
      *
      * @param port - TCP port to listen on
      */
-    listen(port: number): void;
+    run(port: number, callback: VoidFunction, hostname?: string): void;
     /**
      * Sets a global prefix for all routes.
      *

package/dist/app.js

@@ -4,11 +4,12 @@ exports.createApp = exports.App = void 0;
 const routing_1 = require("./routing");
 const http_1 = require("./http");
 const exceptions_1 = require("./exceptions");
-const nodeNativeServer_1 = require("./server/nodeNativeServer");
 const views_1 = require("./views");
 const node_path_1 = require("node:path");
 const app_1 = require("./helpers/app");
 const fileStaticHandler_1 = require("./static/fileStaticHandler");
+const node_http_1 = require("node:http");
+const httpExceptions_1 = require("./exceptions/httpExceptions");
 /**
  * The `App` class acts as the **execution kernel** and **lifecycle orchestrator**
  * of the framework.
@@ -30,8 +31,6 @@ const fileStaticHandler_1 = require("./static/fileStaticHandler");
 class App {
     /** Main routing system */
     router;
-    /** Underlying HTTP server implementation */
-    server;
     /**
      * View engine used to render templates.
      *
@@ -52,7 +51,6 @@ class App {
     static bootstrap() {
         const app = (0, app_1.singleton)(App);
         app.router = new routing_1.Router();
-        app.server = new nodeNativeServer_1.NodeServer(app);
         app.view = new views_1.RaptorEngine((0, node_path_1.join)(__dirname, "..", "views"));
         return app;
     }
@@ -107,8 +105,13 @@ class App {
      *
      * @param port - TCP port to listen on
      */
-    listen(port) {
-        this.server.listen(port);
+    run(port, callback, hostname = "127.0.0.1") {
+        (0, node_http_1.createServer)((req, res) => {
+            const adapter = new http_1.NodeHttpAdapter(req, res);
+            void this.handle(adapter);
+        }).listen(port, hostname, () => {
+            callback();
+        });
     }
     /**
      * Sets a global prefix for all routes.
@@ -168,16 +171,8 @@ class App {
      * This method centralizes error handling and response mapping.
      */
     handleError(error, adapter) {
-        if (error instanceof exceptions_1.HttpNotFoundException) {
-            adapter.sendResponse(http_1.Response.text("Not Found").setStatus(404));
-            return;
-        }
-        if (error instanceof exceptions_1.ContentParserException) {
-            adapter.sendResponse(http_1.Response.json({ message: error.message }).setStatus(422));
-            return;
-        }
-        if (error instanceof exceptions_1.SessionException) {
-            adapter.sendResponse(http_1.Response.json({ message: error.message }).setStatus(401));
+        if (error instanceof httpExceptions_1.HttpException) {
+            adapter.sendResponse(http_1.Response.json(error.toJSON()).setStatus(error.statusCode));
             return;
         }
         if (error instanceof exceptions_1.ValidationException) {
@@ -187,7 +182,10 @@ class App {
             }).setStatus(400));
             return;
         }
-        adapter.sendResponse(http_1.Response.text("Internal Server Error").setStatus(500));
+        adapter.sendResponse(http_1.Response.json({
+            statusCode: 500,
+            message: "Internal Server Error",
+        }).setStatus(500));
         console.error(error);
     }
 }

package/dist/exceptions/httpExceptions.d.ts

@@ -0,0 +1,57 @@
+export interface HttpExceptionOptions {
+    message?: string;
+    statusCode?: number;
+    code?: string;
+}
+export declare class HttpException extends Error {
+    readonly statusCode: number;
+    readonly code: string;
+    constructor(options: HttpExceptionOptions);
+    toJSON(): {
+        message: string;
+        statusCode: number;
+        code: string;
+    };
+}
+export declare class BadRequestError extends HttpException {
+    constructor(message: string);
+}
+export declare class UnauthorizedError extends HttpException {
+    constructor(message: string);
+}
+export declare class ForbiddenError extends HttpException {
+    constructor(message: string);
+}
+export declare class NotFoundError extends HttpException {
+    constructor(message: string);
+}
+export declare class RequestTimeoutError extends HttpException {
+    constructor(message: string);
+}
+export declare class ConflictError extends HttpException {
+    constructor(message: string);
+}
+export declare class UnsopportedMediaTypeError extends HttpException {
+    constructor(message: string);
+}
+export declare class UnprocessableContentError extends HttpException {
+    constructor(message: string);
+}
+export declare class TooManyRequestsError extends HttpException {
+    constructor(message: string);
+}
+export declare class InternalServerError extends HttpException {
+    constructor(message: string);
+}
+export declare class NotImplementedError extends HttpException {
+    constructor(message: string);
+}
+export declare class BadGatewayError extends HttpException {
+    constructor(message: string);
+}
+export declare class ServiceUnavailableError extends HttpException {
+    constructor(message: string);
+}
+export declare class GatewayTimeoutError extends HttpException {
+    constructor(message: string);
+}

package/dist/exceptions/httpExceptions.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatewayTimeoutError = exports.ServiceUnavailableError = exports.BadGatewayError = exports.NotImplementedError = exports.InternalServerError = exports.TooManyRequestsError = exports.UnprocessableContentError = exports.UnsopportedMediaTypeError = exports.ConflictError = exports.RequestTimeoutError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.BadRequestError = exports.HttpException = void 0;
+class HttpException extends Error {
+    statusCode;
+    code;
+    constructor(options) {
+        super(options.message ?? "Internal Server Error");
+        this.name = this.constructor.name;
+        this.statusCode = options.statusCode ?? 500;
+        this.code = options.code ?? "INTERNAL_SERVER_ERROR";
+        Error.captureStackTrace(this, this.constructor);
+    }
+    toJSON() {
+        return {
+            message: this.message,
+            statusCode: this.statusCode,
+            code: this.code,
+        };
+    }
+}
+exports.HttpException = HttpException;
+// Errores 4xx - Client
+class BadRequestError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 400, code: "BAD_REQUEST" });
+    }
+}
+exports.BadRequestError = BadRequestError;
+class UnauthorizedError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 401, code: "UNAUTHORIZED" });
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;
+class ForbiddenError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 403, code: "FORBIDDEN" });
+    }
+}
+exports.ForbiddenError = ForbiddenError;
+class NotFoundError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 404, code: "NOT_FOUND" });
+    }
+}
+exports.NotFoundError = NotFoundError;
+class RequestTimeoutError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 408, code: "REQUEST_TIMEOUT" });
+    }
+}
+exports.RequestTimeoutError = RequestTimeoutError;
+class ConflictError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 409, code: "CONFLICT" });
+    }
+}
+exports.ConflictError = ConflictError;
+class UnsopportedMediaTypeError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 415, code: "UNSOPPORTED_MEDIA_TYPE" });
+    }
+}
+exports.UnsopportedMediaTypeError = UnsopportedMediaTypeError;
+class UnprocessableContentError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 422, code: "UNPROCESSABLE_CONTENT" });
+    }
+}
+exports.UnprocessableContentError = UnprocessableContentError;
+class TooManyRequestsError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 429, code: "TOO_MANY_REQUESTS" });
+    }
+}
+exports.TooManyRequestsError = TooManyRequestsError;
+// Errores 5xx - Servidor
+class InternalServerError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 500, code: "INTERNAL_SERVER_ERROR" });
+    }
+}
+exports.InternalServerError = InternalServerError;
+class NotImplementedError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 501, code: "NOT_IMPLEMENTED" });
+    }
+}
+exports.NotImplementedError = NotImplementedError;
+class BadGatewayError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 502, code: "BAD_GATEWAY" });
+    }
+}
+exports.BadGatewayError = BadGatewayError;
+class ServiceUnavailableError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 503, code: "SERVICE_UNAVAILABLE" });
+    }
+}
+exports.ServiceUnavailableError = ServiceUnavailableError;
+class GatewayTimeoutError extends HttpException {
+    constructor(message) {
+        super({ message, statusCode: 504, code: "GATEWAY_TIMEOUT" });
+    }
+}
+exports.GatewayTimeoutError = GatewayTimeoutError;

package/dist/exceptions/index.d.ts

@@ -1,9 +1,5 @@
-export { ContentParserException, ReadBodyException, } from "./contentParserException";
 export { FileNotExistsException } from "./fileExistsException";
-export { HttpNotFoundException } from "./httpNotFoundException";
 export { HelperExecutionException, HelperNotFoundException, HelperArgumentException, } from "./helperExceptions";
 export { ValidationException, ValidatorFieldException, } from "./validationException";
 export { ContentDispositionException } from "./contentDispositionException";
-export { FileDownloadException } from "./fileDownloadException";
-export { SessionException } from "./sessionException";
 export { InvalidHttpStatusException } from "./invalidHttpStatusException";

package/dist/exceptions/index.js

@@ -1,13 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidHttpStatusException = exports.SessionException = exports.FileDownloadException = exports.ContentDispositionException = exports.ValidatorFieldException = exports.ValidationException = exports.HelperArgumentException = exports.HelperNotFoundException = exports.HelperExecutionException = exports.HttpNotFoundException = exports.FileNotExistsException = exports.ReadBodyException = exports.ContentParserException = void 0;
-var contentParserException_1 = require("./contentParserException");
-Object.defineProperty(exports, "ContentParserException", { enumerable: true, get: function () { return contentParserException_1.ContentParserException; } });
-Object.defineProperty(exports, "ReadBodyException", { enumerable: true, get: function () { return contentParserException_1.ReadBodyException; } });
+exports.InvalidHttpStatusException = exports.ContentDispositionException = exports.ValidatorFieldException = exports.ValidationException = exports.HelperArgumentException = exports.HelperNotFoundException = exports.HelperExecutionException = exports.FileNotExistsException = void 0;
 var fileExistsException_1 = require("./fileExistsException");
 Object.defineProperty(exports, "FileNotExistsException", { enumerable: true, get: function () { return fileExistsException_1.FileNotExistsException; } });
-var httpNotFoundException_1 = require("./httpNotFoundException");
-Object.defineProperty(exports, "HttpNotFoundException", { enumerable: true, get: function () { return httpNotFoundException_1.HttpNotFoundException; } });
 var helperExceptions_1 = require("./helperExceptions");
 Object.defineProperty(exports, "HelperExecutionException", { enumerable: true, get: function () { return helperExceptions_1.HelperExecutionException; } });
 Object.defineProperty(exports, "HelperNotFoundException", { enumerable: true, get: function () { return helperExceptions_1.HelperNotFoundException; } });
@@ -17,9 +12,5 @@ Object.defineProperty(exports, "ValidationException", { enumerable: true, get: f
 Object.defineProperty(exports, "ValidatorFieldException", { enumerable: true, get: function () { return validationException_1.ValidatorFieldException; } });
 var contentDispositionException_1 = require("./contentDispositionException");
 Object.defineProperty(exports, "ContentDispositionException", { enumerable: true, get: function () { return contentDispositionException_1.ContentDispositionException; } });
-var fileDownloadException_1 = require("./fileDownloadException");
-Object.defineProperty(exports, "FileDownloadException", { enumerable: true, get: function () { return fileDownloadException_1.FileDownloadException; } });
-var sessionException_1 = require("./sessionException");
-Object.defineProperty(exports, "SessionException", { enumerable: true, get: function () { return sessionException_1.SessionException; } });
 var invalidHttpStatusException_1 = require("./invalidHttpStatusException");
 Object.defineProperty(exports, "InvalidHttpStatusException", { enumerable: true, get: function () { return invalidHttpStatusException_1.InvalidHttpStatusException; } });

package/dist/http/nodeNativeHttp.js

@@ -42,8 +42,12 @@ class NodeHttpAdapter {
             .setMethod(this.req.method || httpMethods_1.HttpMethods.get)
             .setQueryParams(Object.fromEntries(url.searchParams.entries()))
             .setHeaders(this.req.headers);
-        const parsedData = await this.contentParser.parse(this.req);
-        request.setData(parsedData);
+        if (request.getMethod === httpMethods_1.HttpMethods.post ||
+            request.getMethod === httpMethods_1.HttpMethods.put ||
+            request.getMethod === httpMethods_1.HttpMethods.patch) {
+            const parsedData = await this.contentParser.parse(this.req);
+            request.setData(parsedData);
+        }
         return request;
     }
     /**

package/dist/http/request.d.ts

@@ -1,6 +1,5 @@
 import { HttpMethods } from "./httpMethods";
 import type { Headers, HttpValue } from "../types";
-import { Layer } from "../routing/layer";
 import { FieldDefinition } from "../validators";
 import { Session } from "../sessions";
 /**
@@ -18,8 +17,6 @@ import { Session } from "../sessions";
 export declare class Request {
     /** Normalized request path (e.g. "/api/users/42") */
     private url;
-    /** Routing layer that resolved this request */
-    private layer;
     /** Incoming HTTP headers */
     private headers;
     /** Normalized HTTP method */
@@ -28,14 +25,14 @@ export declare class Request {
     private data;
     /** Query string parameters */
     private query;
+    /** Dynamic route parameters (path params) */
+    private params;
     /** Session associated with the request */
     private session;
     constructor(url: string);
     get getUrl(): string;
     get getMethod(): HttpMethods;
     setMethod(method: HttpMethods): this;
-    get getLayer(): Layer;
-    setLayer(layer: Layer): this;
     get getHeaders(): Headers;
     setHeaders(headers: Headers): this;
     /**
@@ -70,6 +67,7 @@ export declare class Request {
      * request.getParams("id"); // "42"
      */
     getParams(key?: string): HttpValue;
+    setParams(params: Record<string, string>): this;
     getData(): Record<string, unknown>;
     setData(data: Record<string, any>): this;
     get getSession(): Session;

package/dist/http/request.js

@@ -17,8 +17,6 @@ const validators_1 = require("../validators");
 class Request {
     /** Normalized request path (e.g. "/api/users/42") */
     url;
-    /** Routing layer that resolved this request */
-    layer;
     /** Incoming HTTP headers */
     headers;
     /** Normalized HTTP method */
@@ -27,6 +25,8 @@ class Request {
     data = {};
     /** Query string parameters */
     query = {};
+    /** Dynamic route parameters (path params) */
+    params = {};
     /** Session associated with the request */
     session;
     constructor(url) {
@@ -42,13 +42,6 @@ class Request {
         this.method = method;
         return this;
     }
-    get getLayer() {
-        return this.layer;
-    }
-    setLayer(layer) {
-        this.layer = layer;
-        return this;
-    }
     get getHeaders() {
         return this.headers;
     }
@@ -95,10 +88,13 @@ class Request {
      * request.getParams("id"); // "42"
      */
     getParams(key = null) {
-        const parameters = this.layer.parseParameters(this.url);
         if (key === null)
-            return parameters;
-        return parameters[key] ?? null;
+            return this.params;
+        return this.params[key] ?? null;
+    }
+    setParams(params) {
+        this.params = params;
+        return this;
     }
     getData() {
         return this.data;

package/dist/http/response.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Response = void 0;
-const container_1 = require("../container/container");
-const app_1 = require("../app");
 const statusCodes_1 = require("./statusCodes");
 const exceptions_1 = require("../exceptions");
+const app_1 = require("../helpers/app");
 /**
  * Represents an outgoing response sent to the client.
  *
@@ -172,7 +171,7 @@ class Response {
      * return Response.render("auth/login", {}, "auth");
      */
     static async render(view, params, layout = null) {
-        const content = await container_1.Container.resolve(app_1.App).view.render(view, params, layout);
+        const content = await (0, app_1.app)().view.render(view, params, layout);
         return new this().setContentType("text/html").setContent(content);
     }
 }

package/dist/middlewares/index.d.ts

@@ -0,0 +1,2 @@
+export { cors } from "./cors";
+export { sessions } from "./session";

package/dist/middlewares/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sessions = exports.cors = void 0;
+var cors_1 = require("./cors");
+Object.defineProperty(exports, "cors", { enumerable: true, get: function () { return cors_1.cors; } });
+var session_1 = require("./session");
+Object.defineProperty(exports, "sessions", { enumerable: true, get: function () { return session_1.sessions; } });