Merge pull request #22 from perseidesjs/changeset-release/develop

Version Packages

Author: adevinwild

.changeset/honest-points-pay.md

@@ -1,5 +1,67 @@
 # @perseidesjs/medusa-plugin-rate-limit
 
+## 3.0.0
+
+### Major Changes
+
+- 5e0ee7a: V3 - Revamped the whole way we rate limit apps. Introducing the `RateLimit` class for more granular control.
+
+  **Breaking Changes:**
+  - The `defaultRateLimit` middleware has been removed
+  - Global configuration has been removed
+
+  **New Features:**
+  - Introduction of the `RateLimit` class for programmatic rate limiting
+  - Built-in `ipRateLimit` middleware for common IP-based rate limiting
+  - Support for custom identifiers beyond IP addresses
+  - More granular control over rate limiting logic
+
+  ## The RateLimit Class
+
+  The core of V3 is the new `RateLimit` class that gives you programmatic control over rate limiting. This class integrates directly with Medusa's cache service and allows you to implement custom rate limiting logic.
+
+  ### Basic Usage
+
+  ```ts title="src/api/middlewares.ts"
+  import { defineMiddlewares } from "@medusajs/medusa";
+  import { RateLimit } from "@perseidesjs/medusa-plugin-rate-limit";
+  import { Modules } from "@medusajs/framework/utils";
+
+  export default defineMiddlewares({
+    routes: [
+      {
+        matcher: "/store/custom*",
+        middlewares: [
+          async (
+            req: MedusaRequest,
+            res: MedusaResponse,
+            next: MedusaNextFunction,
+          ) => {
+            const cacheService = req.scope.resolve(Modules.CACHE);
+            const rateLimit = new RateLimit({
+              cacheService,
+              options: {
+                limit: 50, // 50 requests per minute
+                window: 60,
+              },
+            });
+
+            const ip = req.headers["x-forwarded-for"] as string;
+            const { success } = await rateLimit.limit(ip);
+            if (!success) {
+              res
+                .status(429)
+                .send("Too many requests, please try again later.");
+              return;
+            }
+            next();
+          },
+        ],
+      },
+    ],
+  });
+  ```
+
 ## 2.2.0
 
 ### Minor Changes

CHANGELOG.md

@@ -1,6 +1,6 @@
 {
 	"name": "@perseidesjs/medusa-plugin-rate-limit",
-	"version": "3.0.0-next.1",
+	"version": "3.0.0",
 	"description": "A simple rate-limit middleware for Medusa",
 	"author": "adevinwild",
 	"license": "MIT",
@@ -31,7 +31,7 @@
 		"build:publish": "rimraf dist && tsc --build ./tsconfig.build.json",
 		"watch": "tsc --watch",
 		"format": "biome format --write",
-		"typecheck":"tsc -b --noEmit",
+		"typecheck": "tsc -b --noEmit",
 		"lint": "biome lint --write",
 		"prepublishOnly": "npm run build",
 		"version": "changeset version",