bun-platform-kit 1.0.0

package/dist/modules/RateLimitModule.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitModule = void 0;
+const abstract_1 = require("../abstract");
+class RateLimitModule extends abstract_1.BaseServerModule {
+    constructor(limiterOptions) {
+        super();
+        this.name = "RateLimit";
+        this.priority = -70;
+        this.limiterOptions = limiterOptions || {
+            windowMs: 8 * 60 * 1000, // 8 minutes
+            limit: 100,
+            standardHeaders: true,
+            legacyHeaders: false,
+        };
+    }
+    getModuleName() {
+        return this.name;
+    }
+    init(app, context) {
+        app.use(createRateLimitMiddleware(this.limiterOptions));
+    }
+}
+exports.RateLimitModule = RateLimitModule;
+const createRateLimitMiddleware = (options) => {
+    const windowMsOption = options?.windowMs;
+    const windowMs = typeof windowMsOption === "number" ? windowMsOption : 8 * 60 * 1000;
+    const legacyMax = options?.max;
+    const limitOption = options?.limit ?? legacyMax;
+    const limit = typeof limitOption === "number" ? limitOption : 100;
+    const hits = new Map();
+    return (req, res, next) => {
+        const key = req.ip || String(req.headers?.["x-forwarded-for"] || "unknown");
+        const now = Date.now();
+        const existing = hits.get(key);
+        if (!existing || existing.expiresAt <= now) {
+            hits.set(key, { count: 1, expiresAt: now + windowMs });
+        }
+        else {
+            existing.count += 1;
+        }
+        const current = hits.get(key);
+        const remaining = Math.max(0, limit - current.count);
+        if (options?.standardHeaders) {
+            res.set("ratelimit-limit", String(limit));
+            res.set("ratelimit-remaining", String(remaining));
+            res.set("ratelimit-reset", String(Math.ceil(current.expiresAt / 1000)));
+        }
+        if (current.count > limit) {
+            const message = typeof options?.message === "string" ||
+                (typeof options?.message === "object" && options?.message)
+                ? options.message
+                : undefined;
+            res.status(429).json(message || {
+                message: "Too many requests, please try again later.",
+            });
+            return;
+        }
+        next();
+    };
+};

package/dist/modules/RequestContextModule.d.ts

@@ -0,0 +1,18 @@
+import { BaseServerModule } from "../abstract";
+import { ServerApp, ServerContext } from "../abstract";
+export declare class RequestContextModule extends BaseServerModule {
+    name: string;
+    priority: number;
+    init(app: ServerApp, _context?: ServerContext): void;
+    getModuleName(): string;
+}
+interface Context {
+    requestId: string;
+}
+declare class RequestContext {
+    private static storage;
+    static get currentContext(): Context | undefined;
+    static get requestId(): string | undefined;
+    static run(context: Context, callback: () => void): void;
+}
+export { RequestContext };

package/dist/modules/RequestContextModule.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContext = exports.RequestContextModule = void 0;
+const abstract_1 = require("../abstract");
+const async_hooks_1 = require("async_hooks");
+class RequestContextModule extends abstract_1.BaseServerModule {
+    constructor() {
+        super(...arguments);
+        this.name = "RequestContext";
+        this.priority = -50;
+    }
+    init(app, _context) {
+        const requestContextMiddleware = async (req, _res, next) => {
+            const incomingRequestId = req.headers["x-request-id"];
+            const requestId = (Array.isArray(incomingRequestId)
+                ? incomingRequestId[0]
+                : incomingRequestId) || (await createRequestId());
+            req.requestId = requestId;
+            RequestContext.run({ requestId }, () => {
+                next();
+            });
+        };
+        app.use(requestContextMiddleware);
+    }
+    getModuleName() {
+        return this.name;
+    }
+}
+exports.RequestContextModule = RequestContextModule;
+class RequestContext {
+    // Obtiene el contexto actual
+    static get currentContext() {
+        return this.storage.getStore();
+    }
+    // Obtiene el requestId actual del contexto
+    static get requestId() {
+        return this.currentContext?.requestId;
+    }
+    // Inicializa el contexto
+    static run(context, callback) {
+        this.storage.run(context, callback);
+    }
+}
+exports.RequestContext = RequestContext;
+RequestContext.storage = new async_hooks_1.AsyncLocalStorage();
+const createRequestId = async () => {
+    const cryptoObj = globalThis.crypto;
+    if (cryptoObj?.randomUUID) {
+        return cryptoObj.randomUUID();
+    }
+    return `${Date.now()}-${Math.random().toString(16).slice(2)}`;
+};

package/dist/modules/SecurityModule.d.ts

@@ -0,0 +1,11 @@
+import { BaseServerModule } from "../abstract";
+import { ServerApp, ServerContext } from "../abstract";
+import type { HelmetOptions } from "helmet";
+export declare class SecurityModule extends BaseServerModule {
+    name: string;
+    priority: number;
+    private readonly helmetOptions;
+    constructor(helmetOptions?: HelmetOptions);
+    getModuleName(): string;
+    init(app: ServerApp, context?: ServerContext): void;
+}

package/dist/modules/SecurityModule.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityModule = void 0;
+const abstract_1 = require("../abstract");
+class SecurityModule extends abstract_1.BaseServerModule {
+    constructor(helmetOptions) {
+        super();
+        this.name = "Security";
+        this.priority = -80;
+        this.helmetOptions = helmetOptions || {
+            contentSecurityPolicy: false,
+            crossOriginEmbedderPolicy: false,
+            crossOriginOpenerPolicy: false,
+            crossOriginResourcePolicy: false,
+            dnsPrefetchControl: true,
+            frameguard: { action: "deny" },
+            hidePoweredBy: true,
+            ieNoOpen: true,
+            noSniff: true,
+            originAgentCluster: true,
+            permittedCrossDomainPolicies: false,
+            referrerPolicy: { policy: "no-referrer" },
+        };
+    }
+    getModuleName() {
+        return this.name;
+    }
+    init(app, context) {
+        app.use(createSecurityMiddleware(this.helmetOptions));
+    }
+}
+exports.SecurityModule = SecurityModule;
+const createSecurityMiddleware = (options) => {
+    return (_req, res, next) => {
+        const frameguard = options?.frameguard;
+        if (frameguard && typeof frameguard === "object" && "action" in frameguard) {
+            const action = frameguard.action;
+            if (action) {
+                res.set("x-frame-options", action.toUpperCase());
+            }
+        }
+        if (options?.ieNoOpen !== false) {
+            res.set("x-download-options", "noopen");
+        }
+        if (options?.noSniff !== false) {
+            res.set("x-content-type-options", "nosniff");
+        }
+        if (options?.originAgentCluster) {
+            res.set("origin-agent-cluster", "?1");
+        }
+        if (options?.permittedCrossDomainPolicies === false) {
+            res.set("x-permitted-cross-domain-policies", "none");
+        }
+        const referrerPolicy = options?.referrerPolicy;
+        if (referrerPolicy && typeof referrerPolicy === "object" && "policy" in referrerPolicy) {
+            res.set("referrer-policy", Array.isArray(referrerPolicy.policy)
+                ? referrerPolicy.policy.join(",")
+                : referrerPolicy.policy);
+        }
+        if (options?.dnsPrefetchControl) {
+            res.set("x-dns-prefetch-control", "on");
+        }
+        next();
+    };
+};

package/dist/modules/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./CorsModule";
+export * from "./ControllersModule";
+export * from "./FileUploadModule";
+export * from "./RateLimitModule";
+export * from "./RequestContextModule";
+export * from "./SecurityModule";

package/dist/modules/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CorsModule"), exports);
+__exportStar(require("./ControllersModule"), exports);
+__exportStar(require("./FileUploadModule"), exports);
+__exportStar(require("./RateLimitModule"), exports);
+__exportStar(require("./RequestContextModule"), exports);
+__exportStar(require("./SecurityModule"), exports);

package/dist/testing/createDecoratedTestApp.d.ts

@@ -0,0 +1,19 @@
+import type { BunKitServer } from "../BunKitServer";
+import { ControllersModule } from "../modules";
+import { BaseServerService, ServerApp } from "../abstract";
+import { BunKitStandardServerOptions } from "../BunKitStandardServer";
+type ControllerClass<T = any> = new (...args: any[]) => T;
+export interface DecoratedTestAppOptions {
+    controllers?: ControllerClass[];
+    controllersModule?: ControllersModule;
+    port?: number;
+    services?: BaseServerService[];
+    standardOptions?: BunKitStandardServerOptions;
+}
+export interface DecoratedTestAppResult {
+    app: ServerApp;
+    server: BunKitServer;
+    stop: () => Promise<void>;
+}
+export declare function createDecoratedTestApp(options: DecoratedTestAppOptions): Promise<DecoratedTestAppResult>;
+export {};

package/dist/testing/createDecoratedTestApp.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDecoratedTestApp = createDecoratedTestApp;
+const BunKitStandardServer_1 = require("../BunKitStandardServer");
+const modules_1 = require("../modules");
+const mergeOptions = (base, override) => {
+    if (!override) {
+        return base;
+    }
+    const mergedServices = [
+        ...(base.services ?? []),
+        ...(override.services ?? []),
+    ];
+    return {
+        adapter: override.adapter ?? base.adapter,
+        services: mergedServices.length ? mergedServices : undefined,
+        modules: {
+            ...(base.modules ?? {}),
+            ...(override.modules ?? {}),
+        },
+    };
+};
+async function createDecoratedTestApp(options) {
+    const { controllers = [], controllersModule, port = 0, services, standardOptions, } = options;
+    const moduleInstance = controllersModule ?? new modules_1.ControllersModule(controllers);
+    const baseOptions = {
+        services,
+        modules: {
+            cors: false,
+            security: false,
+            rateLimit: false,
+        },
+    };
+    const mergedOptions = mergeOptions(baseOptions, standardOptions);
+    const server = (0, BunKitStandardServer_1.BunKitStandardServer)(port, moduleInstance, {
+        ...mergedOptions,
+    });
+    await server.initialize();
+    return {
+        app: server.getApp(),
+        server,
+        stop: async () => {
+            const serverInstance = server.getServer();
+            if (serverInstance) {
+                await new Promise((resolve) => serverInstance.close(() => resolve()));
+            }
+        },
+    };
+}

package/dist/testing/index.d.ts

@@ -0,0 +1 @@
+export * from "./createDecoratedTestApp";

package/dist/testing/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./createDecoratedTestApp"), exports);

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "bun-platform-kit",
+  "author": "angel bejarano / angel.bejarano@jaspesoft.com",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun run tsc -p tsconfig.json",
+    "clean": "rm -rf dist",
+    "prepare": "bun run build",
+    "prebuild": "bun run clean",
+    "format": "bun run prettier --write .",
+    "format:check": "bun run prettier --check .",
+    "typecheck": "bun run tsc --noEmit",
+    "prepack": "bun run build",
+    "test": "bun test",
+    "test:watch": "bun test --watch",
+    "test:coverage": "bun test --coverage"
+  },
+  "keywords": [
+    "server",
+    "framework",
+    "modular",
+    "decorators",
+    "platform",
+    "bun"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "cors": "^2.8.5",
+    "helmet": "^8.1.0",
+    "reflect-metadata": "^0.2.2"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/cors": "^2.8.19",
+    "bun-types": "^1.3.5",
+    "prettier": "^3.6.2",
+    "semantic-release": "^25.0.2",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "bun": ">=1.3.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/abejarano/bun-platform-kit.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  }
+}