@velajs/vela 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -18,6 +18,8 @@ export { EventEmitterModule, EventEmitter, EventEmitterSubscriber, OnEvent, ON_E
 export type { EventHandler, OnEventMetadata } from './event-emitter/index';
 export { ScheduleModule, ScheduleRegistry, ScheduleExecutor, Cron, Interval, SCHEDULE_MODULE_OPTIONS, CRON_METADATA, INTERVAL_METADATA, } from './schedule/index';
 export type { RegisteredCronJob, RegisteredIntervalJob, CronMetadata, IntervalMetadata, ScheduleModuleOptions, } from './schedule/index';
+export { ThrottlerModule, ThrottlerGuard, ThrottlerStorage, Throttle, SkipThrottle, THROTTLER_OPTIONS, THROTTLER_STORAGE, THROTTLE_METADATA, SKIP_THROTTLE_METADATA, } from './throttler/index';
+export type { ThrottlerModuleOptions, ThrottleConfig, ThrottlerStore, ThrottlerStorageRecord, RateLimitInfo, } from './throttler/index';
 export { Module } from './module/index';
 export type { ModuleOptions, DynamicModule } from './module/index';
 export { UseMiddleware, UseGuards, UsePipes, UseInterceptors, UseFilters, Catch, SetMetadata, Reflector, APP_GUARD, APP_PIPE, APP_INTERCEPTOR, APP_FILTER, APP_MIDDLEWARE, } from './pipeline/index';

package/dist/index.js

@@ -21,6 +21,8 @@ export { CacheModule, CacheService, CacheInterceptor, MemoryCacheStore, CacheKey
 export { EventEmitterModule, EventEmitter, EventEmitterSubscriber, OnEvent, ON_EVENT_METADATA } from "./event-emitter/index.js";
 // Schedule
 export { ScheduleModule, ScheduleRegistry, ScheduleExecutor, Cron, Interval, SCHEDULE_MODULE_OPTIONS, CRON_METADATA, INTERVAL_METADATA } from "./schedule/index.js";
+// Throttler
+export { ThrottlerModule, ThrottlerGuard, ThrottlerStorage, Throttle, SkipThrottle, THROTTLER_OPTIONS, THROTTLER_STORAGE, THROTTLE_METADATA, SKIP_THROTTLE_METADATA } from "./throttler/index.js";
 // Module
 export { Module } from "./module/index.js";
 // Pipeline Decorators

package/dist/throttler/index.d.ts

@@ -0,0 +1,6 @@
+export { ThrottlerModule } from './throttler.module';
+export { ThrottlerGuard } from './throttler.guard';
+export { ThrottlerStorage } from './throttler.storage';
+export { Throttle, SkipThrottle } from './throttler.decorators';
+export { THROTTLER_OPTIONS, THROTTLER_STORAGE, THROTTLE_METADATA, SKIP_THROTTLE_METADATA } from './throttler.tokens';
+export type { ThrottlerModuleOptions, ThrottleConfig, ThrottlerStore, ThrottlerStorageRecord, RateLimitInfo } from './throttler.types';

package/dist/throttler/index.js

@@ -0,0 +1,5 @@
+export { ThrottlerModule } from "./throttler.module.js";
+export { ThrottlerGuard } from "./throttler.guard.js";
+export { ThrottlerStorage } from "./throttler.storage.js";
+export { Throttle, SkipThrottle } from "./throttler.decorators.js";
+export { THROTTLER_OPTIONS, THROTTLER_STORAGE, THROTTLE_METADATA, SKIP_THROTTLE_METADATA } from "./throttler.tokens.js";

package/dist/throttler/throttler.decorators.d.ts

@@ -0,0 +1,3 @@
+import type { ThrottleConfig } from './throttler.types';
+export declare const Throttle: (config: ThrottleConfig) => (target: Function | object, propertyKey?: string | symbol) => void;
+export declare const SkipThrottle: () => (target: Function | object, propertyKey?: string | symbol) => void;

package/dist/throttler/throttler.decorators.js

@@ -0,0 +1,4 @@
+import { SetMetadata } from "../pipeline/reflector.js";
+import { THROTTLE_METADATA, SKIP_THROTTLE_METADATA } from "./throttler.tokens.js";
+export const Throttle = (config)=>SetMetadata(THROTTLE_METADATA, config);
+export const SkipThrottle = ()=>SetMetadata(SKIP_THROTTLE_METADATA, true);

package/dist/throttler/throttler.guard.d.ts

@@ -0,0 +1,9 @@
+import type { CanActivate, ExecutionContext } from '../pipeline/types';
+import type { ThrottlerModuleOptions, ThrottlerStore } from './throttler.types';
+export declare class ThrottlerGuard implements CanActivate {
+    private options;
+    private storage;
+    private reflector;
+    constructor(options: ThrottlerModuleOptions, storage: ThrottlerStore);
+    canActivate(context: ExecutionContext): Promise<boolean>;
+}

package/dist/throttler/throttler.guard.js

@@ -0,0 +1,72 @@
+function _ts_decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata(k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+function _ts_param(paramIndex, decorator) {
+    return function(target, key) {
+        decorator(target, key, paramIndex);
+    };
+}
+import { Injectable, Inject } from "../container/decorators.js";
+import { Reflector } from "../pipeline/reflector.js";
+import { TooManyRequestsException } from "../errors/http-exception.js";
+import { THROTTLER_OPTIONS, THROTTLER_STORAGE, THROTTLE_METADATA, SKIP_THROTTLE_METADATA } from "./throttler.tokens.js";
+export class ThrottlerGuard {
+    options;
+    storage;
+    reflector = new Reflector();
+    constructor(options, storage){
+        this.options = options;
+        this.storage = storage;
+    }
+    async canActivate(context) {
+        const skip = this.reflector.getAllAndOverride(SKIP_THROTTLE_METADATA, context);
+        if (skip) {
+            return true;
+        }
+        const override = this.reflector.getAllAndOverride(THROTTLE_METADATA, context);
+        const limit = override?.limit ?? this.options.limit;
+        const ttl = override?.ttl ?? this.options.ttl;
+        const request = context.getRequest();
+        const tracker = this.options.getTracker ? this.options.getTracker(request) : request.headers.get('x-forwarded-for') ?? 'anonymous';
+        const className = context.getClass().name;
+        const handlerName = String(context.getHandler());
+        const key = this.options.generateKey ? this.options.generateKey(tracker, {
+            className,
+            handlerName
+        }) : `throttler:${className}:${handlerName}:${tracker}`;
+        const { count, ttlMs } = await this.storage.increment(key, ttl);
+        const remaining = Math.max(0, limit - count);
+        const resetSeconds = Math.ceil(ttlMs / 1000);
+        const honoContext = context.getContext();
+        honoContext.header('X-RateLimit-Limit', String(limit));
+        honoContext.header('X-RateLimit-Remaining', String(remaining));
+        honoContext.header('X-RateLimit-Reset', String(resetSeconds));
+        const rateLimitInfo = {
+            limit,
+            remaining,
+            reset: resetSeconds
+        };
+        honoContext.set('rateLimit', rateLimitInfo);
+        if (count > limit) {
+            honoContext.header('Retry-After', String(resetSeconds));
+            throw new TooManyRequestsException();
+        }
+        return true;
+    }
+}
+ThrottlerGuard = _ts_decorate([
+    Injectable(),
+    _ts_param(0, Inject(THROTTLER_OPTIONS)),
+    _ts_param(1, Inject(THROTTLER_STORAGE)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof ThrottlerModuleOptions === "undefined" ? Object : ThrottlerModuleOptions,
+        typeof ThrottlerStore === "undefined" ? Object : ThrottlerStore
+    ])
+], ThrottlerGuard);

package/dist/throttler/throttler.module.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '../module/types';
+import type { ThrottlerModuleOptions } from './throttler.types';
+export declare class ThrottlerModule {
+    static forRoot(options: ThrottlerModuleOptions): DynamicModule;
+}

package/dist/throttler/throttler.module.js

@@ -0,0 +1,43 @@
+import { METADATA_KEYS } from "../constants.js";
+import { defineMetadata } from "../metadata.js";
+import { MetadataRegistry } from "../registry/metadata.registry.js";
+import { APP_GUARD } from "../pipeline/tokens.js";
+import { ThrottlerGuard } from "./throttler.guard.js";
+import { ThrottlerStorage } from "./throttler.storage.js";
+import { THROTTLER_OPTIONS, THROTTLER_STORAGE } from "./throttler.tokens.js";
+export class ThrottlerModule {
+    static forRoot(options) {
+        const moduleClass = class ThrottlerDynamicModule {
+        };
+        Object.defineProperty(moduleClass, 'name', {
+            value: 'ThrottlerModule'
+        });
+        defineMetadata(METADATA_KEYS.MODULE, true, moduleClass);
+        MetadataRegistry.setModuleOptions(moduleClass, {
+            exports: [
+                THROTTLER_OPTIONS,
+                THROTTLER_STORAGE,
+                ThrottlerGuard
+            ]
+        });
+        const providers = [
+            {
+                token: THROTTLER_OPTIONS,
+                useValue: options
+            },
+            {
+                token: THROTTLER_STORAGE,
+                useValue: options.storage ?? new ThrottlerStorage()
+            },
+            ThrottlerGuard,
+            {
+                token: APP_GUARD,
+                useExisting: ThrottlerGuard
+            }
+        ];
+        return {
+            module: moduleClass,
+            providers
+        };
+    }
+}

package/dist/throttler/throttler.storage.d.ts

@@ -0,0 +1,10 @@
+import type { ThrottlerStore, ThrottlerStorageRecord } from './throttler.types';
+export declare class ThrottlerStorage implements ThrottlerStore {
+    private current;
+    private previous;
+    private lastSwap;
+    private readonly swapIntervalMs;
+    increment(key: string, ttlMs: number): ThrottlerStorageRecord;
+    reset(key: string): void;
+    private maybeSwap;
+}

package/dist/throttler/throttler.storage.js

@@ -0,0 +1,44 @@
+function _ts_decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+import { Injectable } from "../container/decorators.js";
+export class ThrottlerStorage {
+    current = new Map();
+    previous = new Map();
+    lastSwap = Date.now();
+    swapIntervalMs = 60_000;
+    increment(key, ttlMs) {
+        this.maybeSwap();
+        const now = Date.now();
+        let entry = this.current.get(key) ?? this.previous.get(key);
+        if (!entry || now >= entry.resetTime) {
+            entry = {
+                count: 0,
+                resetTime: now + ttlMs
+            };
+        }
+        entry.count++;
+        this.current.set(key, entry);
+        return {
+            count: entry.count,
+            ttlMs: entry.resetTime - now
+        };
+    }
+    reset(key) {
+        this.current.delete(key);
+        this.previous.delete(key);
+    }
+    maybeSwap() {
+        const now = Date.now();
+        if (now - this.lastSwap < this.swapIntervalMs) return;
+        this.previous = this.current;
+        this.current = new Map();
+        this.lastSwap = now;
+    }
+}
+ThrottlerStorage = _ts_decorate([
+    Injectable()
+], ThrottlerStorage);

package/dist/throttler/throttler.tokens.d.ts

@@ -0,0 +1,6 @@
+import { InjectionToken } from '../container/types';
+import type { ThrottlerModuleOptions, ThrottlerStore } from './throttler.types';
+export declare const THROTTLER_OPTIONS: InjectionToken<ThrottlerModuleOptions>;
+export declare const THROTTLER_STORAGE: InjectionToken<ThrottlerStore>;
+export declare const THROTTLE_METADATA = "vela:throttle";
+export declare const SKIP_THROTTLE_METADATA = "vela:skip-throttle";

package/dist/throttler/throttler.tokens.js

@@ -0,0 +1,5 @@
+import { InjectionToken } from "../container/types.js";
+export const THROTTLER_OPTIONS = new InjectionToken('THROTTLER_OPTIONS');
+export const THROTTLER_STORAGE = new InjectionToken('THROTTLER_STORAGE');
+export const THROTTLE_METADATA = 'vela:throttle';
+export const SKIP_THROTTLE_METADATA = 'vela:skip-throttle';

package/dist/throttler/throttler.types.d.ts

@@ -0,0 +1,25 @@
+export interface ThrottleConfig {
+    limit: number;
+    ttl: number;
+}
+export interface ThrottlerStorageRecord {
+    count: number;
+    ttlMs: number;
+}
+export interface ThrottlerStore {
+    increment(key: string, ttlMs: number): ThrottlerStorageRecord | Promise<ThrottlerStorageRecord>;
+    reset(key: string): void | Promise<void>;
+}
+export interface RateLimitInfo {
+    limit: number;
+    remaining: number;
+    reset: number;
+}
+export interface ThrottlerModuleOptions extends ThrottleConfig {
+    storage?: ThrottlerStore;
+    getTracker?: (request: Request) => string;
+    generateKey?: (tracker: string, context: {
+        className: string;
+        handlerName: string;
+    }) => string;
+}

package/dist/throttler/throttler.types.js

@@ -0,0 +1 @@
+export { };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velajs/vela",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "NestJS-compatible framework for edge runtimes, powered by Hono",
   "type": "module",
   "main": "./dist/index.js",