@trpc-rate-limiter/cloudflare

This package includes WorkersKV and Durable Object store for the @trpc-rate-limiter.

Installation

1# Using npm/yarn/pnpm/bun
2npm add @trpc-rate-limiter/cloudflare

Usage

Examples

Using WorkersKVStore

1# wrangler.toml
2[[kv_namespaces]]
3binding = "CACHE"
4id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

For more info on setting up your WorkersKV you can check out Get Started Guide on cloudflare.

1// index.ts
2import { WorkersKVStore } from "@trpc-rate-limiter/cloudflare";
3import { trpcRateLimiter } from "@trpc-rate-limiter/hono";
4import { KVNamespace } from "cloudflare:worker";
5
6// Add this in Hono app
7type Bindings = {
8  CACHE: KVNamespace;
9  // ... other binding types
10};
11
12const app = new Hono<{ Bindings: Bindings }>();
13
14const t = initTRPC.context<TRPCContext>().create();
15
16// Apply the rate limiter to the tRPC middleware
17const rateLimiterMiddleware = t.middleware(async ({ ctx, next }) => {
18  const { c } = ctx;
19
20  await trpcRateLimiter<AppRouter>({
21    config: {
22      "auth.signIn": {
23        windowMs: 5 * 60 * 1000,
24        limit: 5,
25      },
26      default: { windowMs: 60 * 1000, limit: 5 },
27    },
28    store: new WorkersKVStore({ namespace: c.env.CACHE }), // Here CACHE is your WorkersKV Binding.
29  })(c);
30
31  return next();
32});

Using DurableObjectStore

1# wrangler.toml
2[[durable_objects.bindings]]
3name = "CACHE"
4class_name = "DurableObjectRateLimiter"
5
6[[migrations]]
7tag = "v1" # Should be unique for each entry
8new_classes = ["DurableObjectRateLimiter"]

For more info on setting up your Durable Objects you can check out Get Started Guide on cloudflare.

1// index.ts
2import { DurableObjectStore, DurableObjectRateLimiter } from "@trpc-rate-limiter/cloudflare";
3import { trpcRateLimiter } from "@trpc-rate-limiter/hono";
4import { Context, Next } from "hono";
5import { DurableObjectNamespace } from "cloudflare:worker";
6
7// Add this in Hono app
8type Bindings = {
9  CACHE: DurableObjectNamespace<DurableObjectRateLimiter>;
10  // ... other binding types
11};
12
13const app = new Hono<{ Bindings: Bindings }>();
14
15const t = initTRPC.context<TRPCContext>().create();
16
17// Apply the rate limiter to the tRPC middleware
18const rateLimiterMiddleware = t.middleware(async ({ ctx, next }) => {
19  const { c } = ctx;
20
21  await trpcRateLimiter<AppRouter>({
22    config: {
23      "auth.signIn": {
24        windowMs: 5 * 60 * 1000,
25        limit: 5,
26      },
27      default: { windowMs: 60 * 1000, limit: 5 },
28    },
29    store: new DurableObjectStore({ namespace: c.env.CACHE }), // Here CACHE is your Durable Object Binding.
30  })(c);
31
32  return next();
33});
34
35// Export DurableObjectRateLimiter in the index file of your Worker
36export { DurableObjectRateLimiter };
37
38export default app;

Configuration Props of WorkersKVStore and DurableObjectStore

namespace

The KV / Durable Object namespace to use. The value you set for <BINDING_NAME> will be used to reference this database / durable object in your Worker.

prefix

The text to prepend to the key in the KV / Durable Object namespace.

Defaults to hrl:.

Credits

The @trpc-rate-limiter/cloudflare is based on the @hono-rate-limiter/cloudflare store.