Rewrite: cleaned up the entire project + added compatibility for grammY v2.0.

Author: Amir-Zouerami

.github/workflows/test.yml

@@ -2,34 +2,54 @@ name: Test and Build
 
 on:
     push:
-        branches: [main]
+        branches:
+            - main
+            - 'rc/**'
     pull_request:
-        branches: [main]
+        branches:
+            - main
 
 jobs:
     test:
-        strategy:
-            matrix:
-                node-version: [22.x, 24.x]
-
         runs-on: ubuntu-latest
 
+        services:
+            redis:
+                image: redis:8-alpine
+                ports:
+                    - 6379:6379
+                options: >-
+                    --health-cmd "redis-cli ping"
+                    --health-interval 10s
+                    --health-timeout 5s
+                    --health-retries 5
+
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v4
+              uses: actions/checkout@v6
 
             - name: Setup Deno
               uses: denoland/setup-deno@v2
               with:
-                  deno-version: v2.x
+                  deno-version: 2.9.5
+                  cache: true
 
             - name: Setup Node.js
-              uses: actions/setup-node@v4
+              uses: actions/setup-node@v6
               with:
-                  node-version: ${{ matrix.node-version }}
+                  node-version: 22
+                  package-manager-cache: false
+
+            - name: Configure JSR npm bridge
+              run: echo '@jsr:registry=https://npm.jsr.io' >> "$HOME/.npmrc"
 
             - name: Install dependencies
-              run: deno ci
+              run: deno install --frozen
+
+            - name: Run release checks
+              run: npm run release:check
 
-            - name: Validate
-              run: npm test
+            - name: Run real Redis integration tests
+              env:
+                  RATELIMITER_REDIS_URL: redis://127.0.0.1:6379
+              run: deno task test:redis

README.md

@@ -1,27 +1,23 @@
-[![Test and Build](https://github.com/Amir-Zouerami/ratelimiter/actions/workflows/test.yml/badge.svg)](https://github.com/Amir-Zouerami/ratelimiter/actions/workflows/test.yml)
-
 # Rate Limit Users (`ratelimiter`)
 
-`ratelimiter` is an advanced and flexible middleware for the grammY framework, designed to protect
-Telegram bots from spam and resource abuse.
+`ratelimiter` is a flexible rate-limiting middleware for grammY with Deno and Node.js support.
 
-<p align="center">
-  <a href="https://github.com/grammyjs/ratelimiter">
-    <img src="./grammy-ratelimiter-cover.jpg" alt="grammY rate limiter cover">
-  </a>
-</p>
+## Usage
 
-At its core, `ratelimiter` acts as a configurable gatekeeper for incoming updates. It allows
-developers to define precise rules for how many messages a user or chat (or any arbitrary entity)
-can send in a given period, ensuring the bot remains responsive and server resources are protected
-from overload.
+See the [official grammY rate limiter documentation](https://grammy.dev/plugins/ratelimiter) for
+installation and usage.
 
-The plugin inspects each incoming message, identifies its source, and decides if it should be
-processed or dismissed based on the rules you set.
+## Development
 
-> **For more information and how-to instructions, please visit**
-> [**the official grammY ratelimiter documentation.**](https://grammy.dev/plugins/ratelimiter)
+Deno is the source runtime; the npm package is generated for Node.js with `deno2node`. Keep public
+APIs strongly typed, documented with JSDoc, and covered in both runtimes.
 
-## License
+```sh
+deno task ok
+npm run typecheck
+npm run lint
+npm run test:node
+```
 
-Distributed under the MIT License. See `LICENSE` for more information.
+Run `deno task test:redis` separately against a disposable Redis instance when changing Redis-backed
+behavior.

deno.jsonc

@@ -1,7 +1,21 @@
 {
 	"name": "@grammyjs/ratelimiter",
 	"version": "2.0.0",
-	"exports": "./mod.ts",
+	"exports": {
+		".": "./mod.ts",
+		"./storages": "./storages.ts"
+	},
+	"publish": {
+		"include": [
+			"LICENSE",
+			"README.md",
+			"deno.jsonc",
+			"grammy-ratelimiter-cover.jpg",
+			"mod.ts",
+			"storages.ts",
+			"src/"
+		]
+	},
 	"lock": {
 		"frozen": true
 	},
@@ -13,11 +27,15 @@
 		]
 	},
 	"tasks": {
-		"check": "deno check mod.ts storages.ts ./src/ tests/core.test.ts",
-		"test": "deno test tests/core.test.ts",
+		"check": "deno check mod.ts storages.ts ./src/ tests/runtime/ tests/contracts/ tests/support/ tests/integration/",
+		"test:runtime": "deno test tests/runtime/",
+		"test:types": "deno check tests/types/public_api.test.ts",
+		"test": "deno task test:runtime && deno task test:types",
+		"test:redis": "deno test --allow-env=RATELIMITER_REDIS_URL --allow-net tests/integration/redis.integration.test.ts",
 		"ok": "deno fmt --check && deno lint && deno task test && deno task check",
 		"fix": "deno fmt && deno lint --fix",
-		"dev": "deno run --watch --allow-all examples/basic.ts"
+		"dev": "deno run --watch --allow-env=BOT_TOKEN --allow-net=api.telegram.org examples/local-deno-bot.ts",
+		"doc:lint": "deno doc --lint mod.ts storages.ts"
 	},
 	"fmt": {
 		"useTabs": true,
@@ -27,10 +45,13 @@
 	},
 	"compilerOptions": {
 		"strict": true,
-		"lib": ["deno.ns", "deno.window"]
+		"lib": [
+			"deno.ns",
+			"deno.window"
+		]
 	},
 	"imports": {
-		"@grammyjs/grammy": "jsr:@grammyjs/grammy@2.0.0-beta.6",
+		"@grammyjs/grammy": "jsr:@grammyjs/grammy@2.0.0-beta.8",
 		"@std/assert": "jsr:@std/assert@^1.0.19"
 	}
 }