@roneysilva25/test 1.0.1 → 1.0.3

package/dist/algorithms/Algorithm.interface.d.ts

@@ -0,0 +1,15 @@
+import type { Storage } from "../db/Storage.js";
+import type { PacketPayload } from "./FixedWindow.interfaces.js";
+export interface HandleArgs {
+    packetKey: string;
+    forwardCb: (packetInfo: PacketPayload) => void;
+    dropCb: (packetInfo: PacketPayload) => void;
+}
+export interface Algorithm {
+    readonly storage: typeof Storage;
+    capacity: number;
+    timeWindowInMs: number;
+    handle: (args: HandleArgs) => void;
+}
+export type AlgorithmConstructorArgs = Omit<Algorithm, "handle">;
+//# sourceMappingURL=Algorithm.interface.d.ts.map

package/dist/algorithms/Algorithm.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Algorithm.interface.d.ts","sourceRoot":"","sources":["../../src/algorithms/Algorithm.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAEjE,MAAM,WAAW,UAAU;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAC;IAC/C,MAAM,EAAC,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,OAAO,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;CACtC;AAED,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC"}

package/dist/algorithms/Algorithm.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Algorithm.interface.js.map

package/dist/algorithms/Algorithm.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Algorithm.interface.js","sourceRoot":"","sources":["../../src/algorithms/Algorithm.interface.ts"],"names":[],"mappings":""}

package/dist/algorithms/FixedWindow.d.ts

@@ -0,0 +1,10 @@
+import { Storage } from "../db/Storage.js";
+import type { HandleArgs, Algorithm, AlgorithmConstructorArgs } from "./Algorithm.interface.js";
+export declare class FixedWindow implements Algorithm {
+    capacity: number;
+    timeWindowInMs: number;
+    storage: typeof Storage;
+    constructor({ capacity, timeWindowInMs, storage, }: AlgorithmConstructorArgs);
+    handle({ packetKey, forwardCb, dropCb }: HandleArgs): void;
+}
+//# sourceMappingURL=FixedWindow.d.ts.map

package/dist/algorithms/FixedWindow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FixedWindow.d.ts","sourceRoot":"","sources":["../../src/algorithms/FixedWindow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEhG,qBAAa,WAAY,YAAW,SAAS;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,OAAO,OAAO,CAAC;gBAEZ,EACR,QAAQ,EACR,cAAc,EACd,OAAO,GACV,EAAE,wBAAwB;IAM3B,MAAM,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,UAAU;CA8BtD"}

package/dist/algorithms/FixedWindow.interfaces.d.ts

@@ -0,0 +1,6 @@
+interface PacketPayload {
+    createdAt: number;
+    allowance: number;
+}
+export { type PacketPayload, };
+//# sourceMappingURL=FixedWindow.interfaces.d.ts.map

package/dist/algorithms/FixedWindow.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FixedWindow.interfaces.d.ts","sourceRoot":"","sources":["../../src/algorithms/FixedWindow.interfaces.ts"],"names":[],"mappings":"AAAA,UAAU,aAAa;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,OAAO,EACH,KAAK,aAAa,GACrB,CAAA"}

package/dist/algorithms/FixedWindow.interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=FixedWindow.interfaces.js.map

package/dist/algorithms/FixedWindow.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FixedWindow.interfaces.js","sourceRoot":"","sources":["../../src/algorithms/FixedWindow.interfaces.ts"],"names":[],"mappings":"AAKA,OAAO,EAEN,CAAA"}

package/dist/algorithms/FixedWindow.js

@@ -0,0 +1,37 @@
+import { Storage } from "../db/Storage.js";
+export class FixedWindow {
+    capacity;
+    timeWindowInMs;
+    storage;
+    constructor({ capacity, timeWindowInMs, storage, }) {
+        this.capacity = capacity;
+        this.timeWindowInMs = timeWindowInMs;
+        this.storage = storage;
+    }
+    handle({ packetKey, forwardCb, dropCb }) {
+        const existingPacket = this.storage.retrieve(packetKey);
+        const currentTime = new Date().getTime();
+        if (!existingPacket || currentTime - existingPacket.createdAt >= this.timeWindowInMs) {
+            const createdPacket = this.storage.store({
+                key: packetKey,
+                payload: {
+                    createdAt: currentTime,
+                    allowance: this.capacity - 1,
+                },
+            });
+            return forwardCb(createdPacket);
+        }
+        if (existingPacket.allowance - 1 >= 0) {
+            const updatedPacket = this.storage.store({
+                key: packetKey,
+                payload: {
+                    createdAt: existingPacket.createdAt,
+                    allowance: existingPacket.allowance - 1,
+                },
+            });
+            return forwardCb(updatedPacket);
+        }
+        return dropCb(existingPacket);
+    }
+}
+//# sourceMappingURL=FixedWindow.js.map

package/dist/algorithms/FixedWindow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FixedWindow.js","sourceRoot":"","sources":["../../src/algorithms/FixedWindow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAI3C,MAAM,OAAO,WAAW;IACpB,QAAQ,CAAS;IACjB,cAAc,CAAS;IACvB,OAAO,CAAiB;IAExB,YAAY,EACR,QAAQ,EACR,cAAc,EACd,OAAO,GACgB;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAc;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAgB,SAAS,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEzC,IAAI,CAAC,cAAc,IAAI,WAAW,GAAG,cAAc,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACnF,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAgB;gBACpD,GAAG,EAAE,SAAS;gBACd,OAAO,EAAE;oBACL,SAAS,EAAE,WAAW;oBACtB,SAAS,EAAE,IAAI,CAAC,QAAQ,GAAG,CAAC;iBAC/B;aACJ,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,cAAc,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAgB;gBACpD,GAAG,EAAE,SAAS;gBACd,OAAO,EAAE;oBACL,SAAS,EAAE,cAAc,CAAC,SAAS;oBACnC,SAAS,EAAE,cAAc,CAAC,SAAS,GAAG,CAAC;iBAC1C;aACJ,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,MAAM,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;CACJ"}

package/dist/controllers/RateLimiterController.d.ts

@@ -0,0 +1,7 @@
+import type { DropArgs, ForwardArgs } from "./RateLimiterController.interfaces.js";
+export declare class RateLimiterController {
+    private configResponseHeaders;
+    drop({ res, req, packetInfo, limiterInfo }: DropArgs): import("express").Response<any, Record<string, any>>;
+    forward({ req, res, next, packetInfo, limiterInfo }: ForwardArgs): void;
+}
+//# sourceMappingURL=RateLimiterController.d.ts.map

package/dist/controllers/RateLimiterController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimiterController.d.ts","sourceRoot":"","sources":["../../src/controllers/RateLimiterController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAyB,QAAQ,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAE1G,qBAAa,qBAAqB;IAC9B,OAAO,CAAC,qBAAqB;IAOtB,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,QAAQ;IAKpD,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,WAAW;CAI1E"}

package/dist/controllers/RateLimiterController.interfaces.d.ts

@@ -0,0 +1,26 @@
+import type { PacketPayload } from "../algorithms/FixedWindow.interfaces.js";
+import type { NextFunction, Response, Request } from "express";
+interface LimiterInfo {
+    capacity: number;
+    timeWindowInMs: number;
+}
+interface ConfigResponseHeaders {
+    res: Response;
+    packetInfo: PacketPayload;
+    limiterInfo: LimiterInfo;
+}
+interface DropArgs {
+    req: Request;
+    res: Response;
+    packetInfo: PacketPayload;
+    limiterInfo: LimiterInfo;
+}
+interface ForwardArgs {
+    req: Request;
+    res: Response;
+    next: NextFunction;
+    packetInfo: PacketPayload;
+    limiterInfo: LimiterInfo;
+}
+export type { ConfigResponseHeaders, DropArgs, ForwardArgs, };
+//# sourceMappingURL=RateLimiterController.interfaces.d.ts.map

package/dist/controllers/RateLimiterController.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimiterController.interfaces.d.ts","sourceRoot":"","sources":["../../src/controllers/RateLimiterController.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAG,MAAM,SAAS,CAAC;AAEhE,UAAU,WAAW;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,qBAAqB;IAC3B,GAAG,EAAE,QAAQ,CAAC;IACd,UAAU,EAAE,aAAa,CAAC;IAC1B,WAAW,EAAE,WAAW,CAAC;CAC5B;AAED,UAAU,QAAQ;IACd,GAAG,EAAE,OAAO,CAAC;IACb,GAAG,EAAE,QAAQ,CAAC;IACd,UAAU,EAAE,aAAa,CAAC;IAC1B,WAAW,EAAE,WAAW,CAAC;CAC5B;AAED,UAAU,WAAW;IACjB,GAAG,EAAE,OAAO,CAAC;IACb,GAAG,EAAE,QAAQ,CAAC;IACd,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,aAAa,CAAC;IAC1B,WAAW,EAAE,WAAW,CAAC;CAC5B;AAED,YAAY,EACR,qBAAqB,EACrB,QAAQ,EACR,WAAW,GACd,CAAA"}

package/dist/controllers/RateLimiterController.interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RateLimiterController.interfaces.js.map

package/dist/controllers/RateLimiterController.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimiterController.interfaces.js","sourceRoot":"","sources":["../../src/controllers/RateLimiterController.interfaces.ts"],"names":[],"mappings":""}

package/dist/controllers/RateLimiterController.js

@@ -0,0 +1,17 @@
+export class RateLimiterController {
+    configResponseHeaders({ limiterInfo, packetInfo, res }) {
+        const resetsIn = limiterInfo.timeWindowInMs + packetInfo.createdAt - new Date().getTime();
+        res.setHeader("X-RateLimit-Limit", limiterInfo.capacity);
+        res.setHeader("X-RateLimit-Remaining", packetInfo.allowance);
+        res.setHeader("X-RateLimit-Reset", resetsIn);
+    }
+    drop({ res, req, packetInfo, limiterInfo }) {
+        this.configResponseHeaders({ res, limiterInfo, packetInfo });
+        return res.status(429).send();
+    }
+    forward({ req, res, next, packetInfo, limiterInfo }) {
+        this.configResponseHeaders({ res, limiterInfo, packetInfo });
+        next();
+    }
+}
+//# sourceMappingURL=RateLimiterController.js.map

package/dist/controllers/RateLimiterController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimiterController.js","sourceRoot":"","sources":["../../src/controllers/RateLimiterController.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,qBAAqB;IACtB,qBAAqB,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,EAA0B;QAClF,MAAM,QAAQ,GAAG,WAAW,CAAC,cAAc,GAAG,UAAU,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAC1F,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzD,GAAG,CAAC,SAAS,CAAC,uBAAuB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;QAC7D,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAEM,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,WAAW,EAAY;QACvD,IAAI,CAAC,qBAAqB,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAClC,CAAC;IAEM,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAe;QACnE,IAAI,CAAC,qBAAqB,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7D,IAAI,EAAE,CAAC;IACX,CAAC;CACJ"}

package/dist/db/Storage.d.ts

@@ -0,0 +1,10 @@
+import type { StoreArgs } from "./Storage.interfaces.js";
+export declare class Storage {
+    private static instance;
+    private storage;
+    private constructor();
+    private static getInstance;
+    static store<Payload>({ key, payload }: StoreArgs<Payload>): Payload;
+    static retrieve<Payload>(key: string): Payload | undefined;
+}
+//# sourceMappingURL=Storage.d.ts.map

package/dist/db/Storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.d.ts","sourceRoot":"","sources":["../../src/db/Storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD,qBAAa,OAAO;IAChB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAU;IACjC,OAAO,CAAC,OAAO,CAAmB;IAElC,OAAO;IAIP,OAAO,CAAC,MAAM,CAAC,WAAW;WAQZ,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,OAAO;WAI7D,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;CAGpE"}

package/dist/db/Storage.interfaces.d.ts

@@ -0,0 +1,6 @@
+interface StoreArgs<Payload> {
+    key: string;
+    payload: Payload;
+}
+export { type StoreArgs, };
+//# sourceMappingURL=Storage.interfaces.d.ts.map

package/dist/db/Storage.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.interfaces.d.ts","sourceRoot":"","sources":["../../src/db/Storage.interfaces.ts"],"names":[],"mappings":"AAAA,UAAU,SAAS,CAAC,OAAO;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,OAAO,EACH,KAAK,SAAS,GACjB,CAAA"}

package/dist/db/Storage.interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Storage.interfaces.js.map

package/dist/db/Storage.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.interfaces.js","sourceRoot":"","sources":["../../src/db/Storage.interfaces.ts"],"names":[],"mappings":"AAKA,OAAO,EAEN,CAAA"}

package/dist/db/Storage.js

@@ -0,0 +1,20 @@
+export class Storage {
+    static instance;
+    storage;
+    constructor() {
+        this.storage = new Map();
+    }
+    static getInstance() {
+        if (!this.instance) {
+            this.instance = new Storage();
+        }
+        return this.instance;
+    }
+    static store({ key, payload }) {
+        return this.getInstance().storage.set(key, payload).get(key);
+    }
+    static retrieve(key) {
+        return this.getInstance().storage.get(key);
+    }
+}
+//# sourceMappingURL=Storage.js.map

package/dist/db/Storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.js","sourceRoot":"","sources":["../../src/db/Storage.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,OAAO;IACR,MAAM,CAAC,QAAQ,CAAU;IACzB,OAAO,CAAmB;IAElC;QACI,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IAC7B,CAAC;IAEO,MAAM,CAAC,WAAW;QACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,OAAO,EAAE,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAU,EAAE,GAAG,EAAE,OAAO,EAAsB;QAC7D,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAU,GAAW;QACvC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;CACJ"}

package/dist/factories/AlgorithmFactory.d.ts

@@ -0,0 +1,6 @@
+import type { Algorithm } from "../algorithms/Algorithm.interface.js";
+import type { GetArgs, IAlgorithmFactory } from "./AlgorithmFactory.interfaces.js";
+export declare class AlgorithmFactory implements IAlgorithmFactory {
+    get({ algorithm, config }: GetArgs): Algorithm;
+}
+//# sourceMappingURL=AlgorithmFactory.d.ts.map

package/dist/factories/AlgorithmFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlgorithmFactory.d.ts","sourceRoot":"","sources":["../../src/factories/AlgorithmFactory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAEnF,qBAAa,gBAAiB,YAAW,iBAAiB;IAC/C,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,GAAG,SAAS;CAQxD"}

package/dist/factories/AlgorithmFactory.interfaces.d.ts

@@ -0,0 +1,11 @@
+import type { Algorithm, AlgorithmConstructorArgs } from "../algorithms/Algorithm.interface.js";
+type Algorithms = "fixed_window";
+interface GetArgs {
+    algorithm: Algorithms;
+    config: AlgorithmConstructorArgs;
+}
+interface IAlgorithmFactory {
+    get(args: GetArgs): Algorithm;
+}
+export { type IAlgorithmFactory, type GetArgs, };
+//# sourceMappingURL=AlgorithmFactory.interfaces.d.ts.map

package/dist/factories/AlgorithmFactory.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlgorithmFactory.interfaces.d.ts","sourceRoot":"","sources":["../../src/factories/AlgorithmFactory.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAEhG,KAAK,UAAU,GAAG,cAAc,CAAC;AAEjC,UAAU,OAAO;IACb,SAAS,EAAE,UAAU,CAAC;IACtB,MAAM,EAAE,wBAAwB,CAAC;CACpC;AAED,UAAU,iBAAiB;IACvB,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC;AAED,OAAO,EACH,KAAK,iBAAiB,EACtB,KAAK,OAAO,GACf,CAAA"}

package/dist/factories/AlgorithmFactory.interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AlgorithmFactory.interfaces.js.map

package/dist/factories/AlgorithmFactory.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlgorithmFactory.interfaces.js","sourceRoot":"","sources":["../../src/factories/AlgorithmFactory.interfaces.ts"],"names":[],"mappings":"AAaA,OAAO,EAGN,CAAA"}

package/dist/factories/AlgorithmFactory.js

@@ -0,0 +1,12 @@
+import { FixedWindow } from "../algorithms/FixedWindow.js";
+export class AlgorithmFactory {
+    get({ algorithm, config }) {
+        switch (algorithm) {
+            case "fixed_window":
+                return new FixedWindow(config);
+            default:
+                throw new Error(`Unknown algorithm: ${algorithm}.`);
+        }
+    }
+}
+//# sourceMappingURL=AlgorithmFactory.js.map

package/dist/factories/AlgorithmFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlgorithmFactory.js","sourceRoot":"","sources":["../../src/factories/AlgorithmFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAI3D,MAAM,OAAO,gBAAgB;IAClB,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,EAAW;QACrC,QAAQ,SAAS,EAAE,CAAC;YAChB,KAAK,cAAc;gBACf,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YACnC;gBACI,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,GAAG,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import type { NextFunction, Request, Response } from "express";
+import type { RateLimiterArgs } from "./interfaces.js";
+declare function rateLimiter({ algorithm, capacity, timeWindowInMs, storage }: RateLimiterArgs): {
+    limit(req: Request, res: Response, next: NextFunction): void;
+};
+export { rateLimiter, };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAI/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAQvD,iBAAS,WAAW,CAAC,EACjB,SAAS,EACT,QAAQ,EACR,cAAc,EACd,OAAiB,EACpB,EAAE,eAAe;eAYC,OAAO,OAAO,QAAQ,QAAQ,YAAY;EA2B5D;AAED,OAAO,EACH,WAAW,GACd,CAAA"}

package/dist/index.js

@@ -0,0 +1,48 @@
+import { Storage } from "./db/Storage.js";
+import { RateLimiterController } from "./controllers/RateLimiterController.js";
+import { AlgorithmFactory } from "./factories/AlgorithmFactory.js";
+function validateIP(req, res) {
+    if (!req.ip) {
+        return res.status(400).send("Invalid IP Address.");
+    }
+}
+function rateLimiter({ algorithm, capacity, timeWindowInMs, storage = Storage }) {
+    const controller = new RateLimiterController();
+    const algFactory = new AlgorithmFactory().get({
+        algorithm,
+        config: {
+            timeWindowInMs,
+            storage,
+            capacity,
+        },
+    });
+    return {
+        limit(req, res, next) {
+            validateIP(req, res);
+            return algFactory.handle({
+                packetKey: req.ip,
+                dropCb: (packetInfo) => controller.drop({
+                    req,
+                    res,
+                    packetInfo,
+                    limiterInfo: {
+                        capacity,
+                        timeWindowInMs,
+                    },
+                }),
+                forwardCb: (packetInfo) => controller.forward({
+                    req,
+                    res,
+                    next,
+                    packetInfo,
+                    limiterInfo: {
+                        capacity,
+                        timeWindowInMs,
+                    },
+                }),
+            });
+        }
+    };
+}
+export { rateLimiter, };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,wCAAwC,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAGnE,SAAS,UAAU,CAAC,GAAY,EAAE,GAAa;IAC3C,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACV,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACvD,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,EACjB,SAAS,EACT,QAAQ,EACR,cAAc,EACd,OAAO,GAAG,OAAO,EACH;IACd,MAAM,UAAU,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC/C,MAAM,UAAU,GAAG,IAAI,gBAAgB,EAAE,CAAC,GAAG,CAAC;QAC1C,SAAS;QACT,MAAM,EAAE;YACJ,cAAc;YACd,OAAO;YACP,QAAQ;SACX;KACJ,CAAC,CAAC;IAEH,OAAO;QACH,KAAK,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;YACjD,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAErB,OAAO,UAAU,CAAC,MAAM,CAAC;gBACrB,SAAS,EAAE,GAAG,CAAC,EAAY;gBAC3B,MAAM,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;oBACpC,GAAG;oBACH,GAAG;oBACH,UAAU;oBACV,WAAW,EAAE;wBACT,QAAQ;wBACR,cAAc;qBACjB;iBACJ,CAAC;gBACF,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;oBAC1C,GAAG;oBACH,GAAG;oBACH,IAAI;oBACJ,UAAU;oBACV,WAAW,EAAE;wBACT,QAAQ;wBACR,cAAc;qBACjB;iBACJ,CAAC;aACL,CAAC,CAAC;QACP,CAAC;KACJ,CAAA;AACL,CAAC;AAED,OAAO,EACH,WAAW,GACd,CAAA"}

package/dist/interfaces.d.ts

@@ -0,0 +1,9 @@
+import type { Storage } from "./db/Storage.js";
+interface RateLimiterArgs {
+    algorithm: "fixed_window";
+    capacity: number;
+    timeWindowInMs: number;
+    storage?: typeof Storage;
+}
+export type { RateLimiterArgs };
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE/C,UAAU,eAAe;IACrB,SAAS,EAAE,cAAc,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,OAAO,CAAC;CAC5B;AAED,YAAY,EACR,eAAe,EAClB,CAAA"}

package/dist/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=interfaces.js.map

package/dist/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":""}

package/dist/test/FixedWindow.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=FixedWindow.test.d.ts.map

package/dist/test/FixedWindow.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FixedWindow.test.d.ts","sourceRoot":"","sources":["../../src/test/FixedWindow.test.ts"],"names":[],"mappings":""}

package/dist/test/FixedWindow.test.js

@@ -0,0 +1,100 @@
+import { FixedWindow } from "../algorithms/FixedWindow.js";
+describe("FixedWindow", () => {
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    const mockGetTime = jest.fn();
+    const mockStore = jest.fn();
+    const mockRetrieve = jest.fn();
+    const mockStorage = {
+        store: mockStore,
+        retrieve: mockRetrieve,
+    };
+    const mockDropCb = jest.fn();
+    const mockForwardCb = jest.fn();
+    const fixedWindowArgs = {
+        capacity: 200,
+        timeWindowInMs: 1000 * 60 * 2,
+        storage: mockStorage,
+    };
+    //@ts-ignore
+    const fixedWindow = new FixedWindow(fixedWindowArgs);
+    jest.spyOn(Date.prototype, "getTime").mockImplementation(mockGetTime);
+    it("should create a packet with maximum allowance, the current timestamp and call forwardCb, all if the packet does not exist yet ", () => {
+        const createdPacket = {
+            key: "packetKey",
+            payload: {
+                createdAt: 1,
+                allowance: fixedWindowArgs.capacity - 1,
+            },
+        };
+        mockGetTime.mockReturnValueOnce(1);
+        mockRetrieve.mockReturnValueOnce(undefined);
+        mockStore.mockReturnValueOnce(createdPacket);
+        fixedWindow.handle({
+            packetKey: "packetKey",
+            dropCb: mockDropCb,
+            forwardCb: mockForwardCb,
+        });
+        expect(mockStore).toHaveBeenCalledWith(createdPacket);
+        expect(mockForwardCb).toHaveBeenCalledWith(createdPacket);
+    });
+    it("should update an existing packet with reset allowance and timestamp, and call forwardCb if the time window has passed", () => {
+        const resetAllowance = fixedWindowArgs.capacity - 1;
+        const updatedPacket = {
+            createdAt: fixedWindowArgs.timeWindowInMs,
+            allowance: resetAllowance,
+        };
+        const currentTimestamp = fixedWindowArgs.timeWindowInMs;
+        mockGetTime.mockReturnValueOnce(currentTimestamp);
+        mockRetrieve.mockReturnValueOnce({
+            createdAt: 0,
+            allowance: 10,
+        });
+        mockStore.mockReturnValueOnce(updatedPacket);
+        fixedWindow.handle({
+            packetKey: "packetKey",
+            dropCb: mockDropCb,
+            forwardCb: mockForwardCb,
+        });
+        expect(mockForwardCb).toHaveBeenCalledWith(updatedPacket);
+    });
+    it("should update an existing packet, decreasing its allowance by 1 and keeping the same createdAt timestamp, when the allowance has not reached 0 (zero)", () => {
+        const foundPacket = {
+            createdAt: 10,
+            allowance: 4,
+        };
+        const updatedPacket = {
+            createdAt: foundPacket.createdAt,
+            allowance: 3,
+        };
+        mockGetTime.mockReturnValueOnce(foundPacket.createdAt + 1);
+        mockRetrieve.mockReturnValueOnce(foundPacket);
+        mockStore.mockReturnValueOnce(updatedPacket);
+        fixedWindow.handle({
+            packetKey: "packetKey",
+            dropCb: mockDropCb,
+            forwardCb: mockForwardCb,
+        });
+        expect(mockStore).toHaveBeenCalledWith({
+            key: "packetKey",
+            payload: updatedPacket,
+        });
+        expect(mockForwardCb).toHaveBeenCalledWith(updatedPacket);
+    });
+    it("should call the dropCb when the allowance has already reached zero.", () => {
+        const foundPacket = {
+            createdAt: 10,
+            allowance: 0,
+        };
+        mockGetTime.mockReturnValueOnce(foundPacket.createdAt + 10);
+        mockRetrieve.mockReturnValueOnce(foundPacket);
+        fixedWindow.handle({
+            packetKey: "packetKey",
+            dropCb: mockDropCb,
+            forwardCb: mockForwardCb,
+        });
+        expect(mockDropCb).toHaveBeenCalledWith(foundPacket);
+    });
+});
+//# sourceMappingURL=FixedWindow.test.js.map

package/dist/test/FixedWindow.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FixedWindow.test.js","sourceRoot":"","sources":["../../src/test/FixedWindow.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IACzB,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG;QAChB,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,YAAY;KACzB,CAAA;IACD,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC7B,MAAM,aAAa,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAEhC,MAAM,eAAe,GAAG;QACpB,QAAQ,EAAE,GAAG;QACb,cAAc,EAAE,IAAI,GAAC,EAAE,GAAC,CAAC;QACzB,OAAO,EAAE,WAAW;KACvB,CAAA;IAED,YAAY;IACZ,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,eAAe,CAAC,CAAC;IAErD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAEtE,EAAE,CAAC,gIAAgI,EAAE,GAAG,EAAE;QACtI,MAAM,aAAa,GAAG;YAClB,GAAG,EAAE,WAAW;YAChB,OAAO,EAAE;gBACL,SAAS,EAAE,CAAC;gBACZ,SAAS,EAAE,eAAe,CAAC,QAAQ,GAAG,CAAC;aAC1C;SACJ,CAAA;QAED,WAAW,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACnC,YAAY,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAC5C,SAAS,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAE7C,WAAW,CAAC,MAAM,CAAC;YACf,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,UAAU;YAClB,SAAS,EAAE,aAAa;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QACtD,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uHAAuH,EAAE,GAAG,EAAE;QAC7H,MAAM,cAAc,GAAG,eAAe,CAAC,QAAQ,GAAG,CAAC,CAAA;QACnD,MAAM,aAAa,GAAG;YAClB,SAAS,EAAE,eAAe,CAAC,cAAc;YACzC,SAAS,EAAE,cAAc;SAC5B,CAAC;QACF,MAAM,gBAAgB,GAAG,eAAe,CAAC,cAAc,CAAC;QAExD,WAAW,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;QAClD,YAAY,CAAC,mBAAmB,CAAC;YAC7B,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,EAAE;SAChB,CAAC,CAAC;QACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAE7C,WAAW,CAAC,MAAM,CAAC;YACf,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,UAAU;YAClB,SAAS,EAAE,aAAa;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uJAAuJ,EAAE,GAAG,EAAE;QAC7J,MAAM,WAAW,GAAG;YAChB,SAAS,EAAE,EAAE;YACb,SAAS,EAAE,CAAC;SACf,CAAA;QAED,MAAM,aAAa,GAAG;YAClB,SAAS,EAAE,WAAW,CAAC,SAAS;YAChC,SAAS,EAAE,CAAC;SACf,CAAA;QAED,WAAW,CAAC,mBAAmB,CAAC,WAAW,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;QAC3D,YAAY,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC9C,SAAS,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAE7C,WAAW,CAAC,MAAM,CAAC;YACf,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,UAAU;YAClB,SAAS,EAAE,aAAa;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC;YACnC,GAAG,EAAE,WAAW;YAChB,OAAO,EAAE,aAAa;SACzB,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC3E,MAAM,WAAW,GAAG;YAChB,SAAS,EAAE,EAAE;YACb,SAAS,EAAE,CAAC;SACf,CAAC;QAEF,WAAW,CAAC,mBAAmB,CAAC,WAAW,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC;QAC5D,YAAY,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAE9C,WAAW,CAAC,MAAM,CAAC;YACf,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,UAAU;YAClB,SAAS,EAAE,aAAa;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roneysilva25/test",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Implementation of the most common rate limiting algorithms: Fixed Window, Sliding Window, Leaky Bucket, Token Bucket. To be used as middleware for express applications.",
   "homepage": "https://github.com/roneysilva25/rate-limiter#readme",
   "bugs": {
@@ -13,7 +13,7 @@
   "license": "ISC",
   "author": "Roney Silva <roney.diego000@gmail.com>  (https://roneysilva25.github.io/portfolio)",
   "type": "module",
-  "main": "./index.js",
+  "main": "./dist/index.js",
   "files": ["dist"],
   "scripts": {
     "test": "npx jest --watch",