@orpc/experimental-ratelimit 0.0.1 → 1.11.1

package/dist/index.d.mts

@@ -12,6 +12,12 @@ interface RatelimitHandlerPluginContext {
         ratelimitResult?: RatelimiterLimitResult;
     };
 }
+/**
+ * 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;
 }
@@ -47,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

@@ -12,6 +12,12 @@ interface RatelimitHandlerPluginContext {
         ratelimitResult?: RatelimiterLimitResult;
     };
 }
+/**
+ * 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;
 }
@@ -47,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,3 +1,4 @@
+import { COMMON_ORPC_ERROR_DEFS } from '@orpc/client';
 import { ORPCError } from '@orpc/server';
 import { value, toArray } from '@orpc/shared';
 
@@ -24,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
             }
           }
         };

package/package.json

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