skyguard-js 1.2.0 → 1.2.2

package/dist/types/index.d.ts

@@ -1,18 +1,18 @@
-import { Response, Request, HttpMethods } from "../http/index";
+import { Response, Context, HttpMethods } from "../http/index";
 import { Layer } from "../routing/layer";
 /**
  * Route controller function.
  *
  * Represents the final endpoint in the execution pipeline.
- * Receives a normalized {@link Request} and must return
+ * Receives a normalized {@link Context} and must return
  * a {@link Response}.
  *
  * @example
- * const handler: RouteHandler = (req) => {
- *   return Response.json({ message: "Hello world" });
+ * const handler: RouteHandler = context => {
+ *   return context.json({ message: "Hello world" });
  * };
  */
-export type RouteHandler = (request: Request) => Promise<Response> | Response;
+export type RouteHandler = (context: Context) => Promise<Response> | Response;
 /**
  * Internal routing table structure.
  *
@@ -82,19 +82,20 @@ export type Constructor<T = unknown> = new (...args: unknown[]) => T;
  *
  * Can be synchronous or asynchronous.
  *
- * @param request - Current {@link Request} instance
+ * @param context - Current {@link Context} instance
  * @param next - Function that executes the next middleware
  * or the route handler
  * @returns A {@link Response} or a Promise resolving to {@link Response}
  *
  * @example
- * const loggerMiddleware: Middleware = async (request, next) => {
- *   console.log(request.getMethod, request.getUrl);
+ * const loggerMiddleware: Middleware = async (context, next) => {
+ *   console.log(context.req.method, context.req.url);
  *
- *   const response = await next(request);
+ *   const response = await next(context);
  *   return response;
  * };
  *
  * app.middlewares(loggerMiddleware);
  */
-export type Middleware = (request: Request, next: RouteHandler) => Response | Promise<Response>;
+export type Middleware = (context: Context, next: RouteHandler) => Response | Promise<Response>;
+export type HandlerOrMiddlewares = RouteHandler | Middleware[];

package/dist/validators/rules/bigIntRule.d.ts

@@ -11,10 +11,4 @@ export interface BigIntRuleOptions extends RuleOptions {
 export declare class BigIntRule extends BaseValidationRule<bigint> {
     constructor();
     validate(context: ValidationContext, options?: BigIntRuleOptions): ValidationError | null;
-    gt(limit: bigint, message?: string): this;
-    gte(limit: bigint, message?: string): this;
-    lt(limit: bigint, message?: string): this;
-    lte(limit: bigint, message?: string): this;
-    positive(message?: string): this;
-    negative(message?: string): this;
 }

package/dist/validators/rules/bigIntRule.js

@@ -25,29 +25,5 @@ class BigIntRule extends validationRule_1.BaseValidationRule {
             return this.createError(field, `${field} must be less than or equal to ${options.lte}`, value);
         return null;
     }
-    gt(limit, message) {
-        this.rules.push({ rule: this, options: { gt: limit, message } });
-        return this;
-    }
-    gte(limit, message) {
-        this.rules.push({ rule: this, options: { gte: limit, message } });
-        return this;
-    }
-    lt(limit, message) {
-        this.rules.push({ rule: this, options: { lt: limit, message } });
-        return this;
-    }
-    lte(limit, message) {
-        this.rules.push({ rule: this, options: { lte: limit, message } });
-        return this;
-    }
-    positive(message) {
-        this.rules.push({ rule: this, options: { positive: true, message } });
-        return this;
-    }
-    negative(message) {
-        this.rules.push({ rule: this, options: { negative: true, message } });
-        return this;
-    }
 }
 exports.BigIntRule = BigIntRule;

package/dist/validators/validationRule.js

@@ -8,7 +8,7 @@ class BaseValidationRule {
     name;
     rules;
     hasOptional = false;
-    defaultValue = undefined;
+    defaultValue;
     converter;
     constructor(name, rules = []) {
         this.name = name;

package/dist/validators/validationSchema.js

@@ -340,20 +340,20 @@ exports.v = new ValidatorRules();
  * @param schema - Validation rules mapped by field name
  */
 const validateRequest = (schema) => {
-    return (request, next) => {
+    return (context, next) => {
         if (schema.body) {
-            const validBody = validator_1.Validator.validateOrFail(request.body, schema.body);
-            request.setBody(validBody);
+            const validBody = validator_1.Validator.validateOrFail(context.body, schema.body);
+            context.req.setBody(validBody);
         }
         if (schema.params) {
-            const validParams = validator_1.Validator.validateOrFail(request.params, schema.params);
-            request.setParams(validParams);
+            const validParams = validator_1.Validator.validateOrFail(context.params, schema.params);
+            context.req.setParams(validParams);
         }
         if (schema.query) {
-            const validQuery = validator_1.Validator.validateOrFail(request.query, schema.query);
-            request.setQuery(validQuery);
+            const validQuery = validator_1.Validator.validateOrFail(context.query, schema.query);
+            context.req.setQuery(validQuery);
         }
-        return next(request);
+        return next(context);
     };
 };
 exports.validateRequest = validateRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skyguard-js",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "A lightweight, dependency-free TypeScript backend framework",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -29,7 +29,7 @@
   "bugs": {
     "url": "https://github.com/Pipe930/Skyguard-js/issues"
   },
-  "homepage": "https://github.com/Pipe930/Skyguard-js#readme",
+  "homepage": "https://pipe930.github.io/skyguard-documentation/",
   "engines": {
     "node": ">=22"
   },

package/dist/helpers/http.d.ts

@@ -1,95 +0,0 @@
-import { Response } from "../http/response";
-/**
- * Creates an HTTP response with a JSON body.
- *
- * @typeParam T - Type of the payload to be serialized.
- * @param data - Data to be serialized as JSON.
- * @returns A `Response` instance with `Content-Type: application/json`.
- *
- * @example
- * return json({ ok: true, userId: 1 });
- */
-export declare function json(data: unknown): Response;
-/**
- * Creates an HTTP response with a plain text body.
- *
- * @param data - Text to be sent as the response body.
- * @returns A `Response` instance with a text-based `Content-Type`.
- *
- * @example
- * return text("Hello world");
- */
-export declare function text(data: string): Response;
-/**
- * Creates an HTTP redirect response to the given URL.
- *
- * @param url - Target URL for the redirection (absolute or relative).
- * @returns A `Response` instance configured as a redirect.
- *
- * @example
- * return redirect("/login");
- */
-export declare function redirect(url: string): Response;
-/**
- * Returns a file as a downloadable response.
- *
- * @param path - File system path to the file (relative or absolute, depending on the runtime).
- * @param filename - Optional filename suggested to the client for the download.
- * @param headers - Optional additional headers to include in the response.
- * @returns A `Promise<Response>` ready to be returned by a route handler.
- *
- * @example
- * return await download("./storage/reports/sales.pdf", "report.pdf", {
- *   "Cache-Control": "no-store",
- * });
- */
-export declare function download(path: string, filename?: string, headers?: Record<string, string>): Promise<Response>;
-/**
- * Renders a template/view and returns an HTTP response with the generated HTML.
- *
- * @param view - View identifier or template path, depending on the template system.
- * @param params - Context variables available inside the template.
- * @param layout - Optional layout name used to wrap the rendered view.
- * @returns A `Promise<Response>` containing the rendered HTML.
- *
- * @example
- * return await render("users/profile", { user }, "main");
- */
-export declare function render(data: string, params?: Record<string, unknown>): Promise<Response>;
-/**
- * Sends a file as an HTTP response.
- *
- * This helper is a thin wrapper around `Response.sendFile`, allowing a file
- * to be streamed to the client while optionally applying custom headers
- * and resolving the file path relative to a root directory.
- *
- * @param filePath - Path to the file to send.
- * @param options - Optional configuration for the file response.
- * @param options.headers - Additional HTTP headers to include in the response
- * (e.g. `Content-Type`, `Cache-Control`, `Content-Disposition`).
- * @param options.root - Base directory used to resolve `filePath`.
- * @returns A `Response` object that streams the requested file to the client.
- *
- * @example
- * // Send a file using an absolute path
- * const response = await sendFile("/var/www/files/report.pdf", {});
- *
- * @example
- * // Send a file relative to a root directory
- * const response = await sendFile("report.pdf", {
- *   root: "/var/www/files",
- * });
- *
- * @example
- * // Send a downloadable file
- * const response = await sendFile("report.pdf", {
- *   root: "/var/www/files",
- *   headers: {
- *     "Content-Disposition": "attachment; filename=\"report.pdf\"",
- *   },
- * });
- */
-export declare function sendFile(filePath: string, options: {
-    headers?: Record<string, string>;
-    root?: string;
-}): Promise<Response>;

package/dist/helpers/http.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.json = json;
-exports.text = text;
-exports.redirect = redirect;
-exports.download = download;
-exports.render = render;
-exports.sendFile = sendFile;
-const response_1 = require("../http/response");
-/**
- * Creates an HTTP response with a JSON body.
- *
- * @typeParam T - Type of the payload to be serialized.
- * @param data - Data to be serialized as JSON.
- * @returns A `Response` instance with `Content-Type: application/json`.
- *
- * @example
- * return json({ ok: true, userId: 1 });
- */
-function json(data) {
-    return response_1.Response.json(data);
-}
-/**
- * Creates an HTTP response with a plain text body.
- *
- * @param data - Text to be sent as the response body.
- * @returns A `Response` instance with a text-based `Content-Type`.
- *
- * @example
- * return text("Hello world");
- */
-function text(data) {
-    return response_1.Response.text(data);
-}
-/**
- * Creates an HTTP redirect response to the given URL.
- *
- * @param url - Target URL for the redirection (absolute or relative).
- * @returns A `Response` instance configured as a redirect.
- *
- * @example
- * return redirect("/login");
- */
-function redirect(url) {
-    return response_1.Response.redirect(url);
-}
-/**
- * Returns a file as a downloadable response.
- *
- * @param path - File system path to the file (relative or absolute, depending on the runtime).
- * @param filename - Optional filename suggested to the client for the download.
- * @param headers - Optional additional headers to include in the response.
- * @returns A `Promise<Response>` ready to be returned by a route handler.
- *
- * @example
- * return await download("./storage/reports/sales.pdf", "report.pdf", {
- *   "Cache-Control": "no-store",
- * });
- */
-async function download(path, filename, headers) {
-    return await response_1.Response.download(path, filename, headers);
-}
-/**
- * Renders a template/view and returns an HTTP response with the generated HTML.
- *
- * @param view - View identifier or template path, depending on the template system.
- * @param params - Context variables available inside the template.
- * @param layout - Optional layout name used to wrap the rendered view.
- * @returns A `Promise<Response>` containing the rendered HTML.
- *
- * @example
- * return await render("users/profile", { user }, "main");
- */
-async function render(data, params) {
-    return await response_1.Response.render(data, params);
-}
-/**
- * Sends a file as an HTTP response.
- *
- * This helper is a thin wrapper around `Response.sendFile`, allowing a file
- * to be streamed to the client while optionally applying custom headers
- * and resolving the file path relative to a root directory.
- *
- * @param filePath - Path to the file to send.
- * @param options - Optional configuration for the file response.
- * @param options.headers - Additional HTTP headers to include in the response
- * (e.g. `Content-Type`, `Cache-Control`, `Content-Disposition`).
- * @param options.root - Base directory used to resolve `filePath`.
- * @returns A `Response` object that streams the requested file to the client.
- *
- * @example
- * // Send a file using an absolute path
- * const response = await sendFile("/var/www/files/report.pdf", {});
- *
- * @example
- * // Send a file relative to a root directory
- * const response = await sendFile("report.pdf", {
- *   root: "/var/www/files",
- * });
- *
- * @example
- * // Send a downloadable file
- * const response = await sendFile("report.pdf", {
- *   root: "/var/www/files",
- *   headers: {
- *     "Content-Disposition": "attachment; filename=\"report.pdf\"",
- *   },
- * });
- */
-async function sendFile(filePath, options) {
-    return await response_1.Response.sendFile(filePath, options);
-}