@canmertinyo/rate-limit-express 1.3.0 → 1.3.2

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { RateLimiterOptions } from "./interfaces/rate-limiter-options.interface";
-export { rateLimiter, IRateLimitRecord, IRateLimiter } from "./rate.limiter";
+export * from "./interfaces";
+export { rateLimiter } from "./rate.limiter";

package/dist/index.js

@@ -1,5 +1,20 @@
 "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 });
 exports.rateLimiter = void 0;
+__exportStar(require("./interfaces"), exports);
 var rate_limiter_1 = require("./rate.limiter");
 Object.defineProperty(exports, "rateLimiter", { enumerable: true, get: function () { return rate_limiter_1.rateLimiter; } });

package/dist/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./rate-limit-record.interface";
+export * from "./rate-limiter-options.interface";
+export * from "./rate-limiter.interface";

package/dist/interfaces/index.js

@@ -0,0 +1,19 @@
+"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("./rate-limit-record.interface"), exports);
+__exportStar(require("./rate-limiter-options.interface"), exports);
+__exportStar(require("./rate-limiter.interface"), exports);

package/dist/interfaces/rate-limit-record.interface.d.ts

@@ -0,0 +1,5 @@
+export interface RateLimitRecord {
+    key: string;
+    count: number;
+    timestamp: number;
+}

package/dist/interfaces/rate-limit-record.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/rate-limiter-options.interface.d.ts

@@ -1,4 +1,4 @@
-import { IRateLimiter } from "../rate.limiter";
+import { RateLimiter } from "./rate-limiter.interface";
 /**
  * Options for the rate limiter configuration.
  *
@@ -8,6 +8,5 @@ import { IRateLimiter } from "../rate.limiter";
 export interface RateLimiterOptions {
     ms: number;
     maxRequest: number;
-    storage?: IRateLimiter;
+    storage?: RateLimiter;
 }
-export declare const defaultOptions: RateLimiterOptions;

package/dist/interfaces/rate-limiter-options.interface.js

@@ -1,9 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultOptions = void 0;
-const in_memory_storage_1 = require("../in-memory-storage");
-exports.defaultOptions = {
-    ms: 1000,
-    maxRequest: 5,
-    storage: new in_memory_storage_1.InMemoryStorage(),
-};

package/dist/interfaces/rate-limiter.interface.d.ts

@@ -0,0 +1,7 @@
+import { RateLimitRecord } from "./rate-limit-record.interface";
+export interface RateLimiter {
+    getRateLimitRecord(key: string): RateLimitRecord | undefined;
+    createRateLimitRecord(record: RateLimitRecord): RateLimitRecord;
+    updateRateLimitRecord(key: string, timestamp: number, count: number): RateLimitRecord;
+    increment(key: string): RateLimitRecord;
+}

package/dist/interfaces/rate-limiter.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/rate.limiter.d.ts

@@ -1,14 +1,3 @@
 import { Request, Response, NextFunction } from "express";
 import { RateLimiterOptions } from "./interfaces/rate-limiter-options.interface";
 export declare function rateLimiter(options: RateLimiterOptions): (req: Request, res: Response, next: NextFunction) => void;
-export interface IRateLimitRecord {
-    key: string;
-    count: number;
-    timestamp: number;
-}
-export interface IRateLimiter {
-    getRateLimitRecord(key: string): IRateLimitRecord | undefined;
-    createRateLimitRecord(record: IRateLimitRecord): IRateLimitRecord;
-    updateRateLimitRecord(key: string, timestamp: number, count: number): IRateLimitRecord;
-    increment(key: string): IRateLimitRecord;
-}

package/dist/rate.limiter.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rateLimiter = rateLimiter;
 const utils_1 = require("./utils");
-const in_memory_storage_1 = require("./in-memory-storage");
+const in_memory_storage_1 = require("./storages/in-memory.storage");
 const inMemoryStorage = new in_memory_storage_1.InMemoryStorage();
 function rateLimiter(options) {
     return (req, res, next) => {

package/dist/storages/in-memory.storage.d.ts

@@ -0,0 +1,9 @@
+import { RateLimitRecord } from "../interfaces/rate-limit-record.interface";
+import { RateLimiter } from "../interfaces/rate-limiter.interface";
+export declare class InMemoryStorage implements RateLimiter {
+    private store;
+    getRateLimitRecord(key: string): RateLimitRecord | undefined;
+    createRateLimitRecord(record: RateLimitRecord): RateLimitRecord;
+    updateRateLimitRecord(key: string, timestamp: number, count: number): RateLimitRecord;
+    increment(key: string): RateLimitRecord;
+}

package/dist/storages/in-memory.storage.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemoryStorage = void 0;
+class InMemoryStorage {
+    constructor() {
+        this.store = [];
+    }
+    getRateLimitRecord(key) {
+        return this.store.find((x) => x.key === key);
+    }
+    createRateLimitRecord(record) {
+        var index = this.store.push(record);
+        return this.store[index - 1];
+    }
+    updateRateLimitRecord(key, timestamp, count) {
+        var index = this.store.findIndex((x) => x.key === key);
+        this.store[index].count = count;
+        this.store[index].timestamp = timestamp;
+        return this.store[index];
+    }
+    increment(key) {
+        var index = this.store.findIndex((x) => x.key === key);
+        this.store[index].count += 1;
+        return this.store[index];
+    }
+}
+exports.InMemoryStorage = InMemoryStorage;

package/dist/storages/index.d.ts

@@ -0,0 +1 @@
+export * from "./in-memory.storage";

package/dist/storages/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("./in-memory.storage"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canmertinyo/rate-limit-express",
   "description": "A simple rate-limiting middleware for Express.js",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "main": "dist/index.js",
   "license": "MIT",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,2 +1,2 @@
-export { RateLimiterOptions } from "./interfaces/rate-limiter-options.interface";
-export { rateLimiter, IRateLimitRecord, IRateLimiter } from "./rate.limiter";
+export * from "./interfaces";
+export { rateLimiter } from "./rate.limiter";

package/src/interfaces/index.ts

@@ -0,0 +1,3 @@
+export * from "./rate-limit-record.interface";
+export * from "./rate-limiter-options.interface";
+export * from "./rate-limiter.interface";

package/src/interfaces/rate-limit-record.interface.ts

@@ -0,0 +1,5 @@
+export interface RateLimitRecord {
+  key: string;
+  count: number;
+  timestamp: number;
+}

package/src/interfaces/rate-limiter-options.interface.ts

@@ -1,5 +1,4 @@
-import { InMemoryStorage } from "../in-memory-storage";
-import { IRateLimiter } from "../rate.limiter";
+import { RateLimiter } from "./rate-limiter.interface";
 
 /**
  * Options for the rate limiter configuration.
@@ -10,11 +9,5 @@ import { IRateLimiter } from "../rate.limiter";
 export interface RateLimiterOptions {
   ms: number;
   maxRequest: number;
-  storage?: IRateLimiter;
+  storage?: RateLimiter;
 }
-
-export const defaultOptions: RateLimiterOptions = {
-  ms: 1000,
-  maxRequest: 5,
-  storage: new InMemoryStorage(),
-};

package/src/interfaces/rate-limiter.interface.ts

@@ -0,0 +1,12 @@
+import { RateLimitRecord } from "./rate-limit-record.interface";
+
+export interface RateLimiter {
+  getRateLimitRecord(key: string): RateLimitRecord | undefined;
+  createRateLimitRecord(record: RateLimitRecord): RateLimitRecord;
+  updateRateLimitRecord(
+    key: string,
+    timestamp: number,
+    count: number
+  ): RateLimitRecord;
+  increment(key: string): RateLimitRecord;
+}

package/src/rate.limiter.ts

@@ -1,7 +1,7 @@
 import { Request, Response, NextFunction } from "express";
 import { getIp, getTimestamp } from "./utils";
 import { RateLimiterOptions } from "./interfaces/rate-limiter-options.interface";
-import { InMemoryStorage } from "./in-memory-storage";
+import { InMemoryStorage } from "./storages/in-memory.storage";
 
 const inMemoryStorage = new InMemoryStorage();
 
@@ -37,20 +37,3 @@ export function rateLimiter(options: RateLimiterOptions) {
       .json({ message: "Too many requests, please try again later." });
   };
 }
-
-export interface IRateLimitRecord {
-  key: string;
-  count: number;
-  timestamp: number;
-}
-
-export interface IRateLimiter {
-  getRateLimitRecord(key: string): IRateLimitRecord | undefined;
-  createRateLimitRecord(record: IRateLimitRecord): IRateLimitRecord;
-  updateRateLimitRecord(
-    key: string,
-    timestamp: number,
-    count: number
-  ): IRateLimitRecord;
-  increment(key: string): IRateLimitRecord;
-}

package/src/{in-memory-storage.ts → storages/in-memory.storage.ts}

@@ -1,13 +1,14 @@
-import { IRateLimiter, IRateLimitRecord } from "./rate.limiter";
+import { RateLimitRecord } from "../interfaces/rate-limit-record.interface";
+import { RateLimiter } from "../interfaces/rate-limiter.interface";
 
-export class InMemoryStorage implements IRateLimiter {
-  private store: IRateLimitRecord[] = [];
+export class InMemoryStorage implements RateLimiter {
+  private store: RateLimitRecord[] = [];
 
-  getRateLimitRecord(key: string): IRateLimitRecord | undefined {
+  getRateLimitRecord(key: string): RateLimitRecord | undefined {
     return this.store.find((x) => x.key === key);
   }
 
-  createRateLimitRecord(record: IRateLimitRecord): IRateLimitRecord {
+  createRateLimitRecord(record: RateLimitRecord): RateLimitRecord {
     var index = this.store.push(record);
     return this.store[index - 1];
   }
@@ -16,7 +17,7 @@ export class InMemoryStorage implements IRateLimiter {
     key: string,
     timestamp: number,
     count: number
-  ): IRateLimitRecord {
+  ): RateLimitRecord {
     var index = this.store.findIndex((x) => x.key === key);
     this.store[index].count = count;
     this.store[index].timestamp = timestamp;
@@ -24,7 +25,7 @@ export class InMemoryStorage implements IRateLimiter {
     return this.store[index];
   }
 
-  increment(key: string): IRateLimitRecord {
+  increment(key: string): RateLimitRecord {
     var index = this.store.findIndex((x) => x.key === key);
     this.store[index].count += 1;
     return this.store[index];

package/src/storages/index.ts

@@ -0,0 +1 @@
+export * from "./in-memory.storage";

package/src/types/store.type.ts

@@ -1,3 +0,0 @@
-export type Store = {
-  [key: string]: { count: number; timestamp: number };
-};