@clov-std/elysia-ratelimit 3.0.0 → 3.1.1

package/dist/index.js

@@ -13,6 +13,9 @@ var rateLimitResponseSchema = t.Object({
   title: t.String({
     description: "Short, human-readable summary of the error."
   }),
+  status: t.Literal(429, {
+    description: "HTTP status code, repeated in the body per RFC 9457."
+  }),
   detail: t.Optional(t.String({
     description: "Explanation specific to this occurrence."
   }))
@@ -22,7 +25,8 @@ class RateLimitException extends Exception {
   status = 429;
   response = {
     type: RATE_LIMIT_ERROR_KEYS.RATE_LIMIT_EXCEEDED,
-    title: "Too Many Requests"
+    title: "Too Many Requests",
+    status: 429
   };
   constructor(cause) {
     super("Too Many Requests", {
@@ -41,7 +45,11 @@ var extractClientIp = (request, server) => {
   return request.headers.get("x-real-ip") ?? server?.requestIP(request)?.address ?? "127.0.0.1";
 };
 var rateLimitPlugin = (store = new MemoryStore) => new Elysia().macro({
-  rateLimit: ({ limit, window, keyGenerator }) => ({
+  rateLimit: ({
+    limit,
+    window,
+    keyGenerator
+  }) => ({
     response: { 429: rateLimitResponseSchema },
     transform: async ({ set, request, server }) => {
       const route = `${request.method}:${new URL(request.url).pathname}`;
@@ -56,8 +64,10 @@ var rateLimitPlugin = (store = new MemoryStore) => new Elysia().macro({
       set.headers["X-RateLimit-Limit"] = limit.toString();
       set.headers["X-RateLimit-Remaining"] = remaining.toString();
       set.headers["X-RateLimit-Reset"] = reset.toString();
-      if (count > limit)
+      if (count > limit) {
+        set.headers["content-type"] = "application/problem+json";
         throw new RateLimitException({ limit, window, reset });
+      }
     }
   })
 });

package/dist/rate-limit.d.ts

@@ -2,6 +2,7 @@ import { Exception } from '@clov-std/error';
 import { type KvStore } from '@clov-std/kv-store';
 import type { Server } from 'bun';
 import { Elysia, type HTTPHeaders } from 'elysia';
+import type { TLiteral, TObject, TOptional, TString } from 'typebox/type';
 export declare const RATE_LIMIT_ERROR_KEYS: {
     readonly RATE_LIMIT_EXCEEDED: 'elysia-ratelimit.exceeded';
 };
@@ -15,25 +16,18 @@ export interface RateLimitExceeded {
     readonly reset: number;
 }
 /**
- * Shape of the `429` body.
- *
- * `type` is a plain string, not a literal: an application error handler is free to answer
- * with its own key (a localized catalog entry, for instance). `detail` is optional for the
- * same reason, the plugin never sets it.
+ * Shape of the `429` body, following RFC 9457.
  */
-declare const rateLimitResponseSchema: import("typebox").TObject<{
-    type: import("typebox").TString;
-    title: import("typebox").TString;
-    detail: import("typebox").TOptional<import("typebox").TString>;
+declare const rateLimitResponseSchema: TObject<{
+    type: TString;
+    title: TString;
+    status: TLiteral<429>;
+    detail: TOptional<TString>;
 }>;
 /**
  * Thrown when a caller exceeds its allowance.
  *
- * `status` and `response` are read by Elysia's error fallback, so an application that
- * installs no error handler still answers a real `429` with the documented body. They are
- * only a default: any `.error()` handler registered by the application runs first and wins,
- * which is what lets an API localize this error from its own catalog. Match on
- * {@link Exception.key}, not on the message.
+ * @see {@link rateLimitResponseSchema}
  */
 export declare class RateLimitException extends Exception<RateLimitExceeded> {
     /** HTTP status used by Elysia's error fallback. */
@@ -42,6 +36,7 @@ export declare class RateLimitException extends Exception<RateLimitExceeded> {
     readonly response: {
         readonly type: string;
         readonly title: string;
+        readonly status: 429;
     };
     /**
      * Creates a new rate limit exception.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clov-std/elysia-ratelimit",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "description": "Rate limiting plugin for Elysia framework.",
   "keywords": [
     "bun",