fix: type-safed hitinfo

.changeset/happy-pillows-train.md

@@ -0,0 +1,8 @@
+---
+'@trpc-limiter/core': patch
+'@trpc-limiter/memory': patch
+'@trpc-limiter/redis': patch
+'@trpc-limiter/upstash': patch
+---
+
+fix: type-safed hitinfo

README.MD

@@ -62,10 +62,7 @@ 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
-    )}`,
+  message: (hitInfo) => `Too many requests, please try again later. ${hitInfo}`,
   max: 15,
   windowMs: 10000,
   redisClient: redis,

examples/nextjs-redis/src/server/api/trpc.ts

@@ -83,10 +83,7 @@ const rateLimiter = createTrpcRedisLimiter<typeof t>({
     console.log("c$", c);
     return c;
   },
-  message: (hitInfo) =>
-    `Too many requests, please try again later. ${Math.ceil(
-      (hitInfo.reset - Date.now()) / 1000,
-    )}`,
+  message: (hitInfo) => `Too many requests, please try again later. ${hitInfo}`,
   max: 5,
   windowMs: 10000,
   redisClient: redis,

package.json

@@ -14,15 +14,6 @@
     "prepare": "husky install"
   },
   "lint-staged": {
-    "*.{js,json}": "prettier --write",
-    "packages/**/*.{js,jsx,ts,tsx}": [
-      "eslint --fix",
-      "prettier --write"
-    ],
-    "examples/**/*.{js,jsx,ts,tsx}": [
-      "eslint --fix",
-      "prettier --write"
-    ],
     "package.json": "sort-package-json"
   },
   "devDependencies": {

packages/core/src/index.ts

@@ -76,8 +76,8 @@ export const defineTRPCLimiter = <
 
 export const defineLimiterWithProps = <
   T,
-  Store extends IStoreCallback<T> = IStoreCallback<T>,
-  Res = any
+  Res,
+  Store extends IStoreCallback<T> = IStoreCallback<T>
 >(
   adapter: ILimiterAdapter<Store, Res, T>,
   getDefaultOptions: (

packages/memory/src/store.ts

@@ -22,7 +22,7 @@ export class MemoryStore {
   /** Reference to the active timer. */
   interval: NodeJS.Timer
 
-  constructor(options: Required<TRPCRateLimitOptions<AnyRootConfig>>) {
+  constructor(options: Required<TRPCRateLimitOptions<AnyRootConfig, any>>) {
     this.windowMs = options.windowMs
     this.resetTime = calculateNextResetTime(this.windowMs)
     this.hits = {}

packages/redis/README.md

@@ -35,10 +35,7 @@ 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
-    )}`,
+  message: (hitInfo) => `Too many requests, please try again later. ${hitInfo}`,
   max: 15,
   windowMs: 10000,
   redisClient: redis,

packages/redis/src/index.ts

@@ -10,12 +10,28 @@ import {
   IRateLimiterStoreOptions,
 } from 'rate-limiter-flexible'
 
-export const createTrpcRedisLimiter = defineLimiterWithProps<{
-  redisClient: IRateLimiterStoreOptions['storeClient']
-  limiter?: (
-    opts: Required<BaseOpts<AnyRootConfig, any>>
-  ) => IRateLimiterStoreOptions['insuranceLimiter']
-}>(
+const isBlocked = async (store: RateLimiterRedis, fingerprint: string) => {
+  try {
+    await store.consume(fingerprint)
+    return null
+  } catch (error) {
+    if (error instanceof RateLimiterRes) {
+      return Math.round(error.msBeforeNext / 1000) || 1
+    }
+    // Should not happen with `insuranceLimiter`
+    throw error
+  }
+}
+
+export const createTrpcRedisLimiter = defineLimiterWithProps<
+  {
+    redisClient: IRateLimiterStoreOptions['storeClient']
+    limiter?: (
+      opts: Required<BaseOpts<AnyRootConfig, any>>
+    ) => IRateLimiterStoreOptions['insuranceLimiter']
+  },
+  NonNullable<Awaited<ReturnType<typeof isBlocked>>>
+>(
   {
     store: (opts) => {
       return new RateLimiterRedis({
@@ -26,18 +42,7 @@ export const createTrpcRedisLimiter = defineLimiterWithProps<{
         insuranceLimiter: opts.limiter(opts),
       })
     },
-    async isBlocked(store, fingerprint) {
-      try {
-        await store.consume(fingerprint)
-        return null
-      } catch (error) {
-        if (error instanceof RateLimiterRes) {
-          return Math.round(error.msBeforeNext / 1000) || 1
-        }
-        // Should not happen with `insuranceLimiter`
-        throw error
-      }
-    },
+    isBlocked,
   },
   (currentState) => {
     return {

packages/upstash/src/index.ts

@@ -2,22 +2,28 @@ import {
   defineLimiterWithProps,
   BaseOpts,
   AnyRootConfig,
+  defaultFingerPrint,
 } from '@trpc-limiter/core'
 import { Ratelimit } from '@upstash/ratelimit'
 import { RegionRatelimitConfig } from '@upstash/ratelimit/types/single'
 
-export const createTRPCUpstashLimiter = defineLimiterWithProps<{
-  rateLimitOpts: (
-    opts: Required<BaseOpts<AnyRootConfig, any>>
-  ) => RegionRatelimitConfig
-}>(
+const isBlocked = async (store: Ratelimit, fingerprint: string) => {
+  const { success, pending, ...rest } = await store.limit(fingerprint)
+  await pending
+  return success ? null : rest
+}
+
+export const createTRPCUpstashLimiter = defineLimiterWithProps<
+  {
+    rateLimitOpts: (
+      opts: Required<BaseOpts<AnyRootConfig, any>>
+    ) => RegionRatelimitConfig
+  },
+  NonNullable<Awaited<ReturnType<typeof isBlocked>>>
+>(
   {
     store: (opts) => new Ratelimit(opts.rateLimitOpts(opts)),
-    async isBlocked(store, fingerprint) {
-      const { success, pending, ...rest } = await store.limit(fingerprint)
-      await pending
-      return success ? null : rest
-    },
+    isBlocked,
   },
   (currnetState) => {
     return { rateLimitOpts: currnetState.rateLimitOpts }