skyguard-js 1.2.1 → 1.2.3

package/dist/storage/uploader.js

@@ -63,7 +63,7 @@ class Uploader {
      * - If the file field does not exist, it does not error; it only attaches text
      *   fields and continues.
      * - If present, the file is validated, filtered (optional), stored via the
-     *   configured {@link Storage}, and attached as `request.file`.
+     *   configured {@link Storage}, and attached as `ctx.req.files`.
      *
      * @param fieldName Multipart field name expected to contain a file.
      * @returns A framework {@link Middleware} to be used in the route pipeline.
@@ -74,22 +74,22 @@ class Uploader {
      * - INVALID_FILE_TYPE if rejected by the filter
      */
     single(fieldName) {
-        return async (request, next) => {
-            const multipartData = this.getMultipartData(request);
+        return async (context, next) => {
+            const multipartData = this.getMultipartData(context);
             if (!multipartData)
-                return await next(request);
+                return await next(context);
             this.validateFieldLimits(multipartData);
             const fileData = multipartData.files.find(f => f.fieldName === fieldName);
             if (!fileData) {
-                this.attachFieldsToRequest(request, multipartData);
-                return await next(request);
+                this.attachFieldsToRequest(context, multipartData);
+                return await next(context);
             }
             this.validateFileSize(fileData);
-            await this.applyFileFilter(request, fileData);
-            const file = await this.processFile(request, fileData);
-            request.files = file;
-            this.attachFieldsToRequest(request, multipartData);
-            return await next(request);
+            await this.applyFileFilter(context, fileData);
+            const file = await this.processFile(context, fileData);
+            context.req.files = file;
+            this.attachFieldsToRequest(context, multipartData);
+            return await next(context);
         };
     }
     /**
@@ -97,11 +97,11 @@ class Uploader {
      *
      * Behavior:
      * - If no multipart payload is present, it passes through.
-     * - If no files exist for the given field, it sets `request.files = []`,
+     * - If no files exist for the given field, it sets `ctx.req.files = []`,
      *   attaches text fields, and continues.
      * - If the number of files exceeds `maxCount`, it throws.
      * - Each file is validated, filtered (optional), stored, and collected into
-     *   `request.files` as an array of {@link UploadedFile}.
+     *   `ctx.req.files` as an array of {@link UploadedFile}.
      *
      * @param fieldName Multipart field name expected to contain files.
      * @param maxCount Maximum number of files allowed for this field.
@@ -114,16 +114,16 @@ class Uploader {
      * - INVALID_FILE_TYPE if any file is rejected by the filter
      */
     array(fieldName, maxCount = 10) {
-        return async (request, next) => {
-            const multipartData = this.getMultipartData(request);
+        return async (context, next) => {
+            const multipartData = this.getMultipartData(context);
             if (!multipartData)
-                return await next(request);
+                return await next(context);
             this.validateFieldLimits(multipartData);
             const filesData = multipartData.files.filter(file => file.fieldName === fieldName);
             if (filesData.length === 0) {
-                request.files = [];
-                this.attachFieldsToRequest(request, multipartData);
-                return await next(request);
+                context.req.files = [];
+                this.attachFieldsToRequest(context, multipartData);
+                return await next(context);
             }
             if (filesData.length > maxCount) {
                 throw new uploadException_1.UploadException(`Too many files. Expected max ${maxCount} but got ${filesData.length}`, types_1.UploadErrorCode.LIMIT_FILE_COUNT, fieldName);
@@ -131,12 +131,12 @@ class Uploader {
             const files = [];
             for (const fileData of filesData) {
                 this.validateFileSize(fileData);
-                await this.applyFileFilter(request, fileData);
-                files.push(await this.processFile(request, fileData));
+                await this.applyFileFilter(context, fileData);
+                files.push(await this.processFile(context, fileData));
             }
-            request.files = files;
-            this.attachFieldsToRequest(request, multipartData);
-            return await next(request);
+            context.req.files = files;
+            this.attachFieldsToRequest(context, multipartData);
+            return await next(context);
         };
     }
     /**
@@ -145,7 +145,7 @@ class Uploader {
      * Behavior:
      * - Rejects any file whose field name is not declared in `fields`.
      * - Enforces `maxCount` per declared field (defaults to 1).
-     * - Aggregates results as `request.files` in a map:
+     * - Aggregates results as `ctx.req.files` in a map:
      *   `{ [fieldName]: UploadedFile[] }`.
      *
      * @param fields List of allowed fields and their per-field maximum counts.
@@ -159,10 +159,10 @@ class Uploader {
      * - INVALID_FILE_TYPE if rejected by the filter
      */
     fields(fields) {
-        return async (request, next) => {
-            const multipartData = this.getMultipartData(request);
+        return async (context, next) => {
+            const multipartData = this.getMultipartData(context);
             if (!multipartData)
-                return await next(request);
+                return await next(context);
             this.validateFieldLimits(multipartData);
             const filesMap = {};
             const fieldMap = new Map(fields.map(field => [field.name, field.maxCount || 1]));
@@ -176,12 +176,12 @@ class Uploader {
                     throw new uploadException_1.UploadException(`Too many files for field "${fileData.fieldName}". Max ${maxCount}`, types_1.UploadErrorCode.LIMIT_FILE_COUNT, fileData.fieldName);
                 }
                 this.validateFileSize(fileData);
-                await this.applyFileFilter(request, fileData);
-                filesMap[fileData.fieldName].push(await this.processFile(request, fileData));
+                await this.applyFileFilter(context, fileData);
+                filesMap[fileData.fieldName].push(await this.processFile(context, fileData));
             }
-            request.files = filesMap;
-            this.attachFieldsToRequest(request, multipartData);
-            return await next(request);
+            context.req.files = filesMap;
+            this.attachFieldsToRequest(context, multipartData);
+            return await next(context);
         };
     }
     /**
@@ -189,7 +189,7 @@ class Uploader {
      *
      * Behavior:
      * - Enforces the global total file limit: `limits.files`.
-     * - Stores all files and attaches them as `request.files` (array).
+     * - Stores all files and attaches them as `ctx.req.files` (array).
      *
      * @returns A framework {@link Middleware}.
      *
@@ -200,22 +200,22 @@ class Uploader {
      * - INVALID_FILE_TYPE if rejected by the filter
      */
     any() {
-        return async (request, next) => {
-            const multipartData = this.getMultipartData(request);
+        return async (context, next) => {
+            const multipartData = this.getMultipartData(context);
             if (!multipartData)
-                return await next(request);
+                return await next(context);
             this.validateFieldLimits(multipartData);
             if (multipartData.files.length > this.limits.files)
                 throw new uploadException_1.UploadException(`Too many files. Max ${this.limits.files}`, types_1.UploadErrorCode.LIMIT_FILE_COUNT);
             const files = [];
             for (const fileData of multipartData.files) {
                 this.validateFileSize(fileData);
-                await this.applyFileFilter(request, fileData);
-                files.push(await this.processFile(request, fileData));
+                await this.applyFileFilter(context, fileData);
+                files.push(await this.processFile(context, fileData));
             }
-            request.files = files;
-            this.attachFieldsToRequest(request, multipartData);
-            return await next(request);
+            context.req.files = files;
+            this.attachFieldsToRequest(context, multipartData);
+            return await next(context);
         };
     }
     /**
@@ -231,15 +231,15 @@ class Uploader {
      * - LIMIT_UNEXPECTED_FILE if at least one file is received
      */
     none() {
-        return async (request, next) => {
-            const multipartData = this.getMultipartData(request);
+        return async (context, next) => {
+            const multipartData = this.getMultipartData(context);
             if (!multipartData)
-                return await next(request);
+                return await next(context);
             if (multipartData.files.length > 0) {
                 throw new uploadException_1.UploadException("No files expected", types_1.UploadErrorCode.LIMIT_UNEXPECTED_FILE, multipartData.files[0].fieldName);
             }
-            this.attachFieldsToRequest(request, multipartData);
-            return await next(request);
+            this.attachFieldsToRequest(context, multipartData);
+            return await next(context);
         };
     }
     /**
@@ -249,14 +249,14 @@ class Uploader {
      * @param fileData File descriptor from {@link MultipartData}.
      * @returns The stored file metadata returned by the storage engine.
      */
-    async processFile(request, fileData) {
+    async processFile(context, fileData) {
         const partialFile = {
             fieldName: fileData.fieldName,
             originalname: fileData.filename,
             mimetype: fileData.mimetype,
             size: fileData.size,
         };
-        return await this.storage.handleFile(request, partialFile, fileData.data);
+        return await this.storage.handleFile(context, partialFile, fileData.data);
     }
     /**
      * Extracts multipart data from the request if available.
@@ -264,10 +264,10 @@ class Uploader {
      * @param request Current HTTP request.
      * @returns Parsed multipart data or null if not present.
      */
-    getMultipartData(request) {
-        if (request.headers["content-type"] &&
-            request.headers["content-type"].startsWith("multipart/form-data"))
-            return request.body;
+    getMultipartData(context) {
+        if (context.headers["content-type"] &&
+            context.headers["content-type"].startsWith("multipart/form-data"))
+            return context.body;
         return null;
     }
     /**
@@ -282,7 +282,7 @@ class Uploader {
      * @throws UploadException when the filter rejects the file
      * @throws Error when the filter throws or returns an error
      */
-    applyFileFilter(request, fileData) {
+    applyFileFilter(context, fileData) {
         if (!this.fileFilter)
             return Promise.resolve();
         const partialFile = {
@@ -301,7 +301,7 @@ class Uploader {
             };
             // Call the filter; it may use the callback or return a Promise.
             try {
-                const result = this.fileFilter(request, partialFile, (error, acceptFile) => {
+                const result = this.fileFilter(context, partialFile, (error, acceptFile) => {
                     finish(error, acceptFile);
                 });
                 // If the filter returned a Promise and didn't use the callback,
@@ -349,13 +349,13 @@ class Uploader {
      * @param req Current HTTP request.
      * @param multipartData Parsed multipart payload containing text fields.
      */
-    attachFieldsToRequest(request, multipartData) {
-        const currentData = request.body || {};
+    attachFieldsToRequest(context, multipartData) {
+        const currentData = context.body || {};
         const newData = {
             ...currentData,
             ...multipartData.fields,
         };
-        request.setBody(newData);
+        context.req.setBody(newData);
     }
     /**
      * Creates a storage engine instance from the selected {@link StorageType}.
@@ -397,10 +397,10 @@ class Uploader {
       },
     });
 
-    // Asign middleware a route
-    app.post("/file", (request) => {
-      return json({ file: request.file });
-    }, [uploader.single()])
+    // Assign middleware to a route
+    app.post("/file", [uploader.single("file")], context => {
+      return context.json({ file: context.req.files });
+    })
  */
 const createUploader = (config) => {
     return new Uploader(config);

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/index.d.ts

@@ -1,4 +1,4 @@
-export { ValidationRule } from "./validationRule";
+export type { ValidationRule } from "./validationRule";
 export { Validator } from "./validator";
 export * from "./rules";
-export { RuleOptions, ValidationContext, ValidationError, ValidationResult, FieldDefinition, } from "./types";
+export type { RuleOptions, ValidationContext, ValidationError, ValidationResult, FieldDefinition, } from "./types";

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

@@ -1,9 +1,9 @@
 export { BooleanRule } from "./booleanRule";
-export { DateRule, DateRuleOptions } from "./dateRule";
-export { NumberRule, NumberRuleOptions } from "./numberRule";
-export { StringRule, StringRuleOptions } from "./stringRule";
-export { ArrayRule, ArrayRuleOptions } from "./arrayRule";
+export { DateRule, type DateRuleOptions } from "./dateRule";
+export { NumberRule, type NumberRuleOptions } from "./numberRule";
+export { StringRule, type StringRuleOptions } from "./stringRule";
+export { ArrayRule, type ArrayRuleOptions } from "./arrayRule";
 export { LiteralRule } from "./literalRule";
 export { ObjectRule } from "./objectRule";
 export { UnionRule } from "./unionRule";
-export { BigIntRule, BigIntRuleOptions } from "./bigIntRule";
+export { BigIntRule, type BigIntRuleOptions } from "./bigIntRule";

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.1",
+  "version": "1.2.3",
   "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);
-}