@arkstack/driver-express 0.18.0 → 0.18.1

package/dist/middlewares/index.d.ts

@@ -41,14 +41,17 @@ declare class InertiaMiddleware {
 //#endregion
 //#region src/middlewares/limiter.d.ts
 /**
- *  create a rate limiter middleware
+ * Create a rate limiter middleware
  *
- * @param requests   number of requests allowed per windowMs
- * @param perMin     number of minutes for the window
- * @param message    custom message to be returned when rate limit is exceeded
+ * A limiter translates to [Allow N `(requests)` per N seconds `(windowSeconds)` per IP], or
+ * more explicitly `Allow 100 requests per 30 seconds per IP.`
+ *
+ * @param requests          number of requests allowed per `windowSeconds`
+ * @param windowSeconds     number of seconds for the window
+ * @param message           custom message to be returned when rate limit is exceeded
  * @returns
  */
-declare const limiter: (requests?: number | ValueDeterminingMiddleware<number>, perSec?: number, message?: string | ValueDeterminingMiddleware<string>) => import("express-rate-limit").RateLimitRequestHandler;
+declare const limiter: (requests?: number | ValueDeterminingMiddleware<number>, windowSeconds?: number, message?: string | ValueDeterminingMiddleware<string>) => import("express-rate-limit").RateLimitRequestHandler;
 //#endregion
 //#region src/middlewares/request-logger.d.ts
 /**

package/dist/middlewares/index.js

@@ -134,24 +134,31 @@ var RateLimitExceededException = class extends Exception {
 //#endregion
 //#region src/middlewares/limiter.ts
 /**
-*  create a rate limiter middleware
+* Create a rate limiter middleware
 * 
-* @param requests   number of requests allowed per windowMs
-* @param perMin     number of minutes for the window
-* @param message    custom message to be returned when rate limit is exceeded
+* A limiter translates to [Allow N `(requests)` per N seconds `(windowSeconds)` per IP], or
+* more explicitly `Allow 100 requests per 30 seconds per IP.`
+* 
+* @param requests          number of requests allowed per `windowSeconds`
+* @param windowSeconds     number of seconds for the window
+* @param message           custom message to be returned when rate limit is exceeded
 * @returns 
 */
-const limiter = (requests = 100, perSec = 900, message) => rateLimit({
-	message,
-	limit: requests,
-	windowMs: (env("NODE_ENV") === "production" ? perSec : 30) * 1e3,
-	standardHeaders: true,
-	legacyHeaders: false,
-	ipv6Subnet: 56,
-	handler: (_, __, ___, options) => {
-		throw new RateLimitExceededException(options);
-	}
-});
+const limiter = (requests = 100, windowSeconds = 900, message) => {
+	/** 15 minutes default in production */
+	const windowMs = (env("NODE_ENV") === "production" ? windowSeconds : 30) * 1e3;
+	return rateLimit({
+		message,
+		limit: requests,
+		windowMs,
+		standardHeaders: true,
+		legacyHeaders: false,
+		ipv6Subnet: 56,
+		handler: (_, __, ___, options) => {
+			throw new RateLimitExceededException(options);
+		}
+	});
+};
 //#endregion
 //#region src/middlewares/request-logger.ts
 const colors = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/driver-express",
-  "version": "0.18.0",
+  "version": "0.18.1",
   "type": "module",
   "description": "Express driver for Arkstack, providing Express-based runtime integration for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -43,15 +43,15 @@
     "express-rate-limit": "^8.4.1",
     "multer": "^2.1.1",
     "resora": "^1.3.34",
-    "@arkstack/contract": "^0.18.0",
-    "@arkstack/http": "^0.18.0"
+    "@arkstack/contract": "^0.18.1",
+    "@arkstack/http": "^0.18.1"
   },
   "peerDependencies": {
     "express": "^5.2.1",
-    "@arkstack/auth": "^0.18.0",
-    "@arkstack/common": "^0.18.0",
-    "@arkstack/foundry": "^0.18.0",
-    "@arkstack/inertia": "^0.18.0"
+    "@arkstack/auth": "^0.18.1",
+    "@arkstack/foundry": "^0.18.1",
+    "@arkstack/common": "^0.18.1",
+    "@arkstack/inertia": "^0.18.1"
   },
   "peerDependenciesMeta": {
     "@arkstack/auth": {