limitwall 1.0.0 → 1.0.1

package/README.md

@@ -30,10 +30,10 @@ import { serve } from "@hono/node-server";
 import { Hono } from "hono";
 import { Redis } from "ioredis";
 
-import { rateLimiter, RedisStore } from "limitwall";
+import { NodeRedisStore, rateLimiter } from "limitwall";
 
 const app = new Hono();
-const store = new RedisStore({ client: new Redis() });
+const store = new NodeRedisStore({ client: new Redis() });
 
 app.use(
   "/api/*",
@@ -57,14 +57,14 @@ serve(app);
 import { Redis } from "@upstash/redis/cloudflare";
 import { Hono } from "hono";
 
-import { rateLimiter, UpstashStore } from "limitwall";
+import { rateLimiter, UpstashRedisStore } from "limitwall";
 
 const app = new Hono<{
   Bindings: { UPSTASH_URL: string; UPSTASH_TOKEN: string };
 }>();
 
 app.use("/api/*", async (c, next) => {
-  const store = new UpstashStore({
+  const store = new UpstashRedisStore({
     client: new Redis({ url: c.env.UPSTASH_URL, token: c.env.UPSTASH_TOKEN }),
   });
 
@@ -98,18 +98,18 @@ Every algorithm also accepts `ruleName` (required - namespaces its Redis keys) a
 ## Config reference
 
 ```ts
-rateLimiter({
-  algorithm: "tokenBucket" | "fixedWindow" | "slidingWindow" | "leakyBucket",
-  ruleName: string,
+interface RateLimiterConfig {
+  algorithm: "tokenBucket" | "fixedWindow" | "slidingWindow" | "leakyBucket";
+  ruleName: string;
   // ...algorithm-specific fields, see table above
-  cost?: number,
+  cost?: number;
 
-  identifier: (c: Context) => string,   // required - what to rate limit by
-  store: RateLimitStore,                // RedisStore or UpstashStore
-  onError: "fail-open" | "fail-closed", // required - no silent default
-  headerStyle?: "draft-6" | "draft-7",  // defaults to "draft-6"
-  message?: (c: Context) => Response,   // overrides the default 429 body
-});
+  identifier: (c: Context) => string; // required - what to rate limit by
+  store: RateLimitStore; // NodeRedisStore or UpstashRedisStore
+  onError: "fail-open" | "fail-closed"; // required - no silent default
+  headerStyle?: "draft-6" | "draft-7"; // defaults to "draft-6"
+  message?: (c: Context) => Response; // overrides the default 429 body
+}
 ```
 
 ## Response headers

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "limitwall",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Rate limiting middleware for Hono, backed by Redis. Fixed window, sliding window, token bucket, and leaky bucket (GCRA) in one package",
   "author": "Kevin Rozario",
   "license": "MIT",