chore!: Remove timeout property on ArcjetRateLimitRule (#182)

This removes the `timeout` property on `ArcjetRateLimitRule`. Having timeout on rate limits is confusing because each rate limit has a reset time based on the configuration. If we kept timeout ("block duration") around, it would be very confusing to determine when a user will be able to access the resource again.

We're tracking the concept of timeout ("block duration") in arcjet/arcjet#567.

arcjet/index.ts

@@ -420,7 +420,6 @@ export type RateLimitOptions = {
   characteristics?: string[];
   window: string;
   max: number;
-  timeout: string;
 };
 
 /**
@@ -595,7 +594,6 @@ export function rateLimit(
       characteristics: opt.characteristics,
       window: opt.window,
       max: opt.max,
-      timeout: opt.timeout,
     });
   }
 

arcjet/test/index.node.test.ts

@@ -1926,7 +1926,6 @@ describe("Primitive > rateLimit", () => {
       characteristics: ["ip.src"],
       window: "1h",
       max: 1,
-      timeout: "10m",
     });
     expect(rule.type).toEqual("RATE_LIMIT");
     expect(rule).toHaveProperty("mode", "DRY_RUN");
@@ -1938,7 +1937,6 @@ describe("Primitive > rateLimit", () => {
       characteristics: ["ip.src"],
       window: "1h",
       max: 1,
-      timeout: "10m",
     };
 
     const rules = rateLimit(options);
@@ -1949,7 +1947,6 @@ describe("Primitive > rateLimit", () => {
     expect(rules[0]).toHaveProperty("characteristics", ["ip.src"]);
     expect(rules[0]).toHaveProperty("window", "1h");
     expect(rules[0]).toHaveProperty("max", 1);
-    expect(rules[0]).toHaveProperty("timeout", "10m");
   });
 
   test("produces a multiple rules based on multiple `limit` specified", async () => {
@@ -1959,14 +1956,12 @@ describe("Primitive > rateLimit", () => {
         characteristics: ["ip.src"],
         window: "1h",
         max: 1,
-        timeout: "10m",
       },
       {
         match: "/test-double",
         characteristics: ["ip.src"],
         window: "2h",
         max: 2,
-        timeout: "20m",
       },
     ];
 
@@ -1980,7 +1975,6 @@ describe("Primitive > rateLimit", () => {
         characteristics: ["ip.src"],
         window: "1h",
         max: 1,
-        timeout: "10m",
       }),
       expect.objectContaining({
         type: "RATE_LIMIT",
@@ -1989,7 +1983,6 @@ describe("Primitive > rateLimit", () => {
         characteristics: ["ip.src"],
         window: "2h",
         max: 2,
-        timeout: "20m",
       }),
     ]);
   });
@@ -1998,7 +1991,6 @@ describe("Primitive > rateLimit", () => {
     const options = {
       window: "1h",
       max: 1,
-      timeout: "10m",
     };
 
     const [rule] = rateLimit(options);
@@ -2012,12 +2004,10 @@ describe("Primitive > rateLimit", () => {
       {
         window: "1h",
         max: 1,
-        timeout: "10m",
       },
       {
         window: "2h",
         max: 2,
-        timeout: "20m",
       },
     ];
 
@@ -2030,7 +2020,6 @@ describe("Primitive > rateLimit", () => {
         characteristics: undefined,
         window: "1h",
         max: 1,
-        timeout: "10m",
       }),
       expect.objectContaining({
         type: "RATE_LIMIT",
@@ -2039,7 +2028,6 @@ describe("Primitive > rateLimit", () => {
         characteristics: undefined,
         window: "2h",
         max: 2,
-        timeout: "20m",
       }),
     ]);
   });
@@ -2379,7 +2367,6 @@ describe("Products > protectSignup", () => {
         characteristics: ["ip.src"],
         window: "1h",
         max: 1,
-        timeout: "10m",
       },
       bots: {
         mode: ArcjetMode.DRY_RUN,
@@ -2400,14 +2387,12 @@ describe("Products > protectSignup", () => {
           characteristics: ["ip.src"],
           window: "1h",
           max: 1,
-          timeout: "10m",
         },
         {
           match: "/test",
           characteristics: ["ip.src"],
           window: "2h",
           max: 2,
-          timeout: "20m",
         },
       ],
     });
@@ -3431,7 +3416,6 @@ describe("Arcjet: Env = Serverless Node runtime on Vercel", () => {
       characteristics: ["ip.src"],
       window: "1h",
       max: 1,
-      timeout: "10m",
     };
     const fingerprint =
       "fp_1_ac8547705f1f45c5050f1424700dfa3f6f2f681b550ca4f3c19571585aea7a2c";

examples/nextjs-13-pages-wrap/pages/api/arcjet-edge.ts

@@ -18,7 +18,6 @@ const aj = arcjet({
       //characteristics: ["ip.src"],
       window: "1m",
       max: 1,
-      timeout: "10m",
     }),
   ],
 });

examples/nextjs-13-pages-wrap/pages/api/arcjet.ts

@@ -14,7 +14,6 @@ const aj = arcjet({
       //characteristics: ["ip.src"],
       window: "1m",
       max: 1,
-      timeout: "10m",
     }),
   ],
 });

examples/nextjs-14-app-dir-rl/app/api/arcjet/route.ts

@@ -12,7 +12,6 @@ const aj = arcjet({
       characteristics: ["ip.src"],
       window: "1h",
       max: 1,
-      timeout: "10m",
     }),
   ],
 });

examples/nextjs-14-openai/app/api/chat/route.ts

@@ -16,7 +16,6 @@ const aj = arcjet({
       characteristics: ["ip.src"],
       window: "1m",
       max: 60,
-      timeout: "10m",
     }),
   ],
 });

examples/nextjs-14-pages-wrap/pages/api/arcjet-edge.ts

@@ -18,7 +18,6 @@ const aj = arcjet({
       //characteristics: ["ip.src"],
       window: "1m",
       max: 1,
-      timeout: "10m",
     }),
   ],
 });

examples/nextjs-14-pages-wrap/pages/api/arcjet.ts

@@ -14,7 +14,6 @@ const aj = arcjet({
       //characteristics: ["ip.src"],
       window: "1m",
       max: 1,
-      timeout: "10m",
     }),
   ],
 });

protocol/convert.ts

@@ -485,7 +485,6 @@ export function ArcjetRuleToProtocol<Props extends { [key: string]: unknown }>(
           characteristics: rule.characteristics,
           window: rule.window,
           max: rule.max,
-          timeout: rule.timeout,
         },
       },
     });

protocol/index.ts

@@ -396,7 +396,6 @@ export interface ArcjetRateLimitRule<Props extends {}>
   characteristics?: string[];
   window: string;
   max: number;
-  timeout: string;
 }
 
 export interface ArcjetEmailRule<Props extends { email: string }>