@orpc/experimental-ratelimit 0.0.0 → 1.11.0

package/dist/adapters/memory.mjs

@@ -25,7 +25,8 @@ class MemoryRatelimiter {
     this.lastCleanupTime = now;
     const windowStart = now - this.window;
     for (const [key, timestamps] of this.store) {
-      timestamps.splice(0, timestamps.findIndex((timestamp) => timestamp < windowStart) + 1);
+      const idx = timestamps.findIndex((timestamp) => timestamp >= windowStart);
+      timestamps.splice(0, idx === -1 ? timestamps.length : idx);
       if (timestamps.length === 0) {
         this.store.delete(key);
       }
@@ -36,7 +37,8 @@ class MemoryRatelimiter {
     const windowStart = now - this.window;
     let timestamps = this.store.get(key);
     if (timestamps) {
-      timestamps.splice(0, timestamps.findIndex((timestamp) => timestamp < windowStart) + 1);
+      const idx = timestamps.findIndex((timestamp) => timestamp >= windowStart);
+      timestamps.splice(0, idx === -1 ? timestamps.length : idx);
     } else {
       this.store.set(key, timestamps = []);
     }

package/dist/adapters/redis.d.mts

@@ -1,7 +1,7 @@
 import { a as Ratelimiter, R as RatelimiterLimitResult } from '../shared/experimental-ratelimit.C8zlaHwR.mjs';
 
 interface RedisRatelimiterOptions {
-    eval: (script: string, numKeys: number, ...args: string[]) => Promise<unknown>;
+    eval: (script: string, numKeys: number, ...rest: string[]) => Promise<unknown>;
     /**
      * Block until the request may pass or timeout is reached.
      */

package/dist/adapters/redis.d.ts

@@ -1,7 +1,7 @@
 import { a as Ratelimiter, R as RatelimiterLimitResult } from '../shared/experimental-ratelimit.C8zlaHwR.js';
 
 interface RedisRatelimiterOptions {
-    eval: (script: string, numKeys: number, ...args: string[]) => Promise<unknown>;
+    eval: (script: string, numKeys: number, ...rest: string[]) => Promise<unknown>;
     /**
      * Block until the request may pass or timeout is reached.
      */

package/dist/adapters/redis.mjs

@@ -65,7 +65,14 @@ class RedisRatelimiter {
     if (!Array.isArray(result) || result.length !== 4) {
       throw new TypeError("Invalid response from rate limit script");
     }
-    const [success, limit, remaining, reset] = result;
+    const numbers = result.map((item) => {
+      const num = Number(item);
+      if (!Number.isInteger(num)) {
+        throw new TypeError("Invalid response from rate limit script");
+      }
+      return num;
+    });
+    const [success, limit, remaining, reset] = numbers;
     return {
       success: success === 1,
       limit,

package/dist/adapters/upstash-ratelimit.d.mts

@@ -17,7 +17,7 @@ interface UpstashRatelimiterOptions {
      * On Vercel Edge or Cloudflare workers, you might need `.bind` before assign:
      * ```ts
      * const ratelimiter = new UpstashRatelimiter(ratelimit, {
-     *   waitUtil: ctx.waitUntil.bind(ctx),
+     *   waitUntil: ctx.waitUntil.bind(ctx),
      * })
      * ```
      */

package/dist/adapters/upstash-ratelimit.d.ts

@@ -17,7 +17,7 @@ interface UpstashRatelimiterOptions {
      * On Vercel Edge or Cloudflare workers, you might need `.bind` before assign:
      * ```ts
      * const ratelimiter = new UpstashRatelimiter(ratelimit, {
-     *   waitUtil: ctx.waitUntil.bind(ctx),
+     *   waitUntil: ctx.waitUntil.bind(ctx),
      * })
      * ```
      */

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { R as RatelimiterLimitResult, a as Ratelimiter } from './shared/experime
 import { Value, Promisable } from '@orpc/shared';
 
 declare const RATELIMIT_HANDLER_CONTEXT_SYMBOL: unique symbol;
-interface RatelimitHandlerPluginContext extends Context {
+interface RatelimitHandlerPluginContext {
     [RATELIMIT_HANDLER_CONTEXT_SYMBOL]?: {
         /**
          * The result of the ratelimiter after applying limits
@@ -12,12 +12,13 @@ interface RatelimitHandlerPluginContext extends Context {
         ratelimitResult?: RatelimiterLimitResult;
     };
 }
-declare class RatelimitHandlerPlugin<T extends RatelimitHandlerPluginContext> implements StandardHandlerPlugin<T> {
-    /**
-     * this plugin should lower priority than response headers plugin,
-     * if user want override rate limit headers
-     */
-    order: number;
+/**
+ * Automatically adds HTTP rate-limiting headers (RateLimit-* and Retry-After) to responses
+ * when used with middleware created by createRatelimitMiddleware.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/helpers/ratelimit#handler-plugin Ratelimit handler plugin}
+ */
+declare class RatelimitHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
     init(options: StandardHandlerOptions<T>): void;
 }
 
@@ -43,7 +44,7 @@ interface CreateRatelimitMiddlewareOptions<TInContext extends Context, TInput, T
      */
     key: Value<Promisable<string>, [middlewareOptions: MiddlewareOptions<TInContext, unknown, Record<never, never>, TMeta>, input: TInput]>;
     /**
-     * If you ratelimit middleware is used multiple times
+     * If your ratelimit middleware is used multiple times
      * or you invoke a procedure inside another procedure (shared the same context) that also has
      * ratelimit middleware **with the same limiter and key**, this option
      * will ensure that the limit is only applied once per request.
@@ -52,6 +53,12 @@ interface CreateRatelimitMiddlewareOptions<TInContext extends Context, TInput, T
      */
     dedupe?: boolean;
 }
+/**
+ * Creates a middleware that enforces rate limits in oRPC procedures.
+ * Supports per-request deduplication and integrates with the ratelimit handler plugin.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/helpers/ratelimit#createratelimitmiddleware Ratelimit middleware}
+ */
 declare function createRatelimitMiddleware<TInContext extends Context, TInput = unknown, TMeta extends Meta = Record<never, never>>({ dedupe, ...options }: CreateRatelimitMiddlewareOptions<TInContext, TInput, TMeta>): Middleware<TInContext, Record<never, never>, TInput, any, any, TMeta>;
 
 export { RATELIMIT_HANDLER_CONTEXT_SYMBOL, RATELIMIT_MIDDLEWARE_CONTEXT_SYMBOL, RatelimitHandlerPlugin, Ratelimiter, RatelimiterLimitResult, createRatelimitMiddleware };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { R as RatelimiterLimitResult, a as Ratelimiter } from './shared/experime
 import { Value, Promisable } from '@orpc/shared';
 
 declare const RATELIMIT_HANDLER_CONTEXT_SYMBOL: unique symbol;
-interface RatelimitHandlerPluginContext extends Context {
+interface RatelimitHandlerPluginContext {
     [RATELIMIT_HANDLER_CONTEXT_SYMBOL]?: {
         /**
          * The result of the ratelimiter after applying limits
@@ -12,12 +12,13 @@ interface RatelimitHandlerPluginContext extends Context {
         ratelimitResult?: RatelimiterLimitResult;
     };
 }
-declare class RatelimitHandlerPlugin<T extends RatelimitHandlerPluginContext> implements StandardHandlerPlugin<T> {
-    /**
-     * this plugin should lower priority than response headers plugin,
-     * if user want override rate limit headers
-     */
-    order: number;
+/**
+ * Automatically adds HTTP rate-limiting headers (RateLimit-* and Retry-After) to responses
+ * when used with middleware created by createRatelimitMiddleware.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/helpers/ratelimit#handler-plugin Ratelimit handler plugin}
+ */
+declare class RatelimitHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
     init(options: StandardHandlerOptions<T>): void;
 }
 
@@ -43,7 +44,7 @@ interface CreateRatelimitMiddlewareOptions<TInContext extends Context, TInput, T
      */
     key: Value<Promisable<string>, [middlewareOptions: MiddlewareOptions<TInContext, unknown, Record<never, never>, TMeta>, input: TInput]>;
     /**
-     * If you ratelimit middleware is used multiple times
+     * If your ratelimit middleware is used multiple times
      * or you invoke a procedure inside another procedure (shared the same context) that also has
      * ratelimit middleware **with the same limiter and key**, this option
      * will ensure that the limit is only applied once per request.
@@ -52,6 +53,12 @@ interface CreateRatelimitMiddlewareOptions<TInContext extends Context, TInput, T
      */
     dedupe?: boolean;
 }
+/**
+ * Creates a middleware that enforces rate limits in oRPC procedures.
+ * Supports per-request deduplication and integrates with the ratelimit handler plugin.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/helpers/ratelimit#createratelimitmiddleware Ratelimit middleware}
+ */
 declare function createRatelimitMiddleware<TInContext extends Context, TInput = unknown, TMeta extends Meta = Record<never, never>>({ dedupe, ...options }: CreateRatelimitMiddlewareOptions<TInContext, TInput, TMeta>): Middleware<TInContext, Record<never, never>, TInput, any, any, TMeta>;
 
 export { RATELIMIT_HANDLER_CONTEXT_SYMBOL, RATELIMIT_MIDDLEWARE_CONTEXT_SYMBOL, RatelimitHandlerPlugin, Ratelimiter, RatelimiterLimitResult, createRatelimitMiddleware };

package/dist/index.mjs

@@ -1,16 +1,12 @@
+import { COMMON_ORPC_ERROR_DEFS } from '@orpc/client';
 import { ORPCError } from '@orpc/server';
 import { value, toArray } from '@orpc/shared';
 
 const RATELIMIT_HANDLER_CONTEXT_SYMBOL = Symbol("ORPC_RATE_LIMIT_HANDLER_CONTEXT");
 class RatelimitHandlerPlugin {
-  /**
-   * this plugin should lower priority than response headers plugin,
-   * if user want override rate limit headers
-   */
-  order = 1e5;
   init(options) {
     options.rootInterceptors ??= [];
-    options.rootInterceptors.push(async (interceptorOptions) => {
+    options.rootInterceptors.unshift(async (interceptorOptions) => {
       const handlerContext = {};
       const result = await interceptorOptions.next({
         ...interceptorOptions,
@@ -29,7 +25,7 @@ class RatelimitHandlerPlugin {
               "ratelimit-limit": handlerContext.ratelimitResult.limit?.toString(),
               "ratelimit-remaining": handlerContext.ratelimitResult.remaining?.toString(),
               "ratelimit-reset": handlerContext.ratelimitResult.reset?.toString(),
-              "retry-after": !handlerContext.ratelimitResult.success && result.response.status === 429 && handlerContext.ratelimitResult.reset !== void 0 ? Math.ceil((handlerContext.ratelimitResult.reset - Date.now()) / 1e3).toString() : void 0
+              "retry-after": !handlerContext.ratelimitResult.success && result.response.status === COMMON_ORPC_ERROR_DEFS.TOO_MANY_REQUESTS.status && handlerContext.ratelimitResult.reset !== void 0 ? Math.max(0, Math.ceil((handlerContext.ratelimitResult.reset - Date.now()) / 1e3)).toString() : void 0
             }
           }
         };
@@ -67,7 +63,7 @@ function createRatelimitMiddleware({ dedupe = true, ...options }) {
     return middlewareOptions.next({
       context: {
         [RATELIMIT_MIDDLEWARE_CONTEXT_SYMBOL]: {
-          ...middlewareOptions,
+          ...middlewareContext,
           limits: [
             ...toArray(middlewareContext?.limits),
             { limiter, key }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/experimental-ratelimit",
   "type": "module",
-  "version": "0.0.0",
+  "version": "1.11.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -47,10 +47,10 @@
     }
   },
   "dependencies": {
-    "@orpc/client": "1.10.3",
-    "@orpc/server": "1.10.3",
-    "@orpc/shared": "1.10.3",
-    "@orpc/standard-server": "1.10.3"
+    "@orpc/client": "1.11.0",
+    "@orpc/server": "1.11.0",
+    "@orpc/standard-server": "1.11.0",
+    "@orpc/shared": "1.11.0"
   },
   "devDependencies": {
     "@upstash/ratelimit": "^2.0.7",