feat/fix: get everything up to date + redis adapter

OrJDev · Apr 16, 2024 · 9d70e44 · 9d70e44
1 parent cbf6d75
commit 9d70e44
Show file tree

Hide file tree

Showing 102 changed files with 4,247 additions and 4,596 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -10,5 +10,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["example-solid", "example-nextjs"]
+  "ignore": ["dev-nextjs-upstash", "dev-nextjs-redis"]
 }
diff --git a/.changeset/thick-buses-trade.md b/.changeset/thick-buses-trade.md
@@ -0,0 +1,7 @@
+---
+'@trpc-limiter/core': major
+'@trpc-limiter/memory': major
+'@trpc-limiter/upstash': major
+---
+
+feat/fix: get everything up to date + redis adapter
diff --git a/README.MD b/README.MD
@@ -4,8 +4,72 @@ An open source, tRPC rate limiter middleware.
 
 ## Adapters
 
-- [Upstash / Redis](https://github.com/OrJDev/trpc-limiter/tree/main/packages/upstash)
+- [Redis](https://github.com/OrJDev/trpc-limiter/tree/main/packages/redis)
+- [Upstash](https://github.com/OrJDev/trpc-limiter/tree/main/packages/upstash)
 - [Memory Store](https://github.com/OrJDev/trpc-limiter/tree/main/packages/memory)
 - [Custom](https://github.com/OrJDev/trpc-limiter/tree/main/packages/core)
 
 This project was created because of this tRPC [issue](https://github.com/trpc/trpc/issues/3227) opened by the creator of tRPC.
+
+## Note
+
+Make sure to use the `next` version of tRPC. Meaning when installing a tRPC related package, make sure to install the `@next` version.
+
+```bash
+pnpm install @trpc/server@next @trpc/client@next ...
+```
+
+```ts
+import {
+  createTRPCStoreLimiter,
+  defaultFingerPrint,
+} from '@trpc-limiter/memory'
+
+// or
+
+import {
+  createTRPCUpstashLimiter,
+  defaultFingerPrint,
+} from '@trpc-limiter/upstash'
+
+// or
+
+import { createTrpcRedisLimiter, defaultFingerPrint } from '@trpc-limiter/redis'
+```
+
+## Example (Redis)
+
+```ts
+import { initTRPC } from '@trpc/server'
+import { type NextApiRequest } from 'next'
+import { createTrpcRedisLimiter, defaultFingerPrint } from '@trpc-limiter/redis'
+import { createClient } from 'redis'
+
+export const redis = createClient({
+  password: '...',
+  socket: {
+    host: '...',
+    port: 18382,
+  },
+  disableOfflineQueue: true,
+})
+
+type Context = {
+  req: NextApiRequest
+}
+
+const t = initTRPC.context<Context>().create()
+
+const rateLimiter = createTrpcRedisLimiter<typeof t>({
+  fingerprint: (ctx) => defaultFingerPrint(ctx.req),
+  message: (hitInfo) =>
+    `Too many requests, please try again later. ${Math.ceil(
+      (hitInfo.reset - Date.now()) / 1000
+    )}`,
+  max: 15,
+  windowMs: 10000,
+  redisClient: redis,
+})
+
+export const rateLimitedProcedure = t.procedure.use(rateLimiter)
+```
diff --git a/examples/next/.eslintrc.json b/examples/next/.eslintrc.json
diff --git a/examples/next/CHANGELOG.md b/examples/next/CHANGELOG.md
diff --git a/examples/next/next.config.mjs b/examples/next/next.config.mjs
diff --git a/examples/next/package.json b/examples/next/package.json
diff --git a/examples/next/postcss.config.cjs b/examples/next/postcss.config.cjs
diff --git a/examples/next/prettier.config.cjs b/examples/next/prettier.config.cjs
diff --git a/examples/next/public/favicon.ico b/examples/next/public/favicon.ico
diff --git a/examples/next/src/env/client.mjs b/examples/next/src/env/client.mjs
diff --git a/examples/next/src/env/schema.mjs b/examples/next/src/env/schema.mjs
diff --git a/examples/next/src/env/server.mjs b/examples/next/src/env/server.mjs
diff --git a/examples/next/src/pages/_app.tsx b/examples/next/src/pages/_app.tsx
diff --git a/examples/next/src/pages/api/trpc/[trpc].ts b/examples/next/src/pages/api/trpc/[trpc].ts
diff --git a/examples/next/src/server/trpc/context.ts b/examples/next/src/server/trpc/context.ts
diff --git a/examples/next/src/server/trpc/router/_app.ts b/examples/next/src/server/trpc/router/_app.ts
diff --git a/examples/next/src/server/trpc/router/example.ts b/examples/next/src/server/trpc/router/example.ts