@upstash/ratelimit 0.4.5-canary.0 → 1.0.0

package/examples/with-vercel-kv/app/page.tsx

@@ -1,71 +0,0 @@
-import { Ratelimit } from "@upstash/ratelimit";
-import kv from "@vercel/kv";
-import { Inter } from "next/font/google";
-import { headers } from "next/headers";
-import Image from "next/image";
-import Link from "next/link";
-
-const ratelimit = new Ratelimit({
-  redis: kv,
-  limiter: Ratelimit.fixedWindow(10, "60s"),
-});
-
-export default async function Home() {
-  const ip = headers().get("x-forwarded-for");
-  const { success, limit, remaining, reset } = await ratelimit.limit(ip ?? "anonymous");
-
-  return (
-    <main className="flex flex-col items-center justify-between min-h-screen p-24">
-      <div className="z-10 items-center justify-between w-full max-w-5xl font-mono text-sm lg:flex">
-        <p className="fixed top-0 left-0 flex justify-center w-full pt-8 pb-6 border-b border-gray-300 bg-gradient-to-b from-zinc-200 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30">
-          Check out the source at&nbsp;
-          <Link
-            href="https://github.com/upstash/ratelimit/tree/main/examples/with-vercel-kv"
-            className="font-mono font-bold"
-          >
-            github.com/upstash/ratelimit
-          </Link>
-        </p>
-      </div>
-
-      <div className="relative text-4xl lg:text-7xl font-semibold text-center flex place-items-center before:absolute before:h-[300px] before:w-[480px] before:-translate-x-1/2 before:rounded-full  before:content-[''] after:absolute after:-z-20 after:h-[180px] after:w-[240px] after:translate-x-1/3 ">
-        {success ? (
-          <>
-            @upstash/ratelimit
-            <br />+
-            <br />
-            Vercel KV
-          </>
-        ) : (
-          <>
-            You have reached the limit,
-            <br />
-            please come back later
-          </>
-        )}
-      </div>
-
-      <div className="grid mb-32 text-center lg:mb-0 lg:grid-cols-4 lg:text-left">
-        <div className="px-5 py-4 transition-colors border border-transparent rounded-lg group hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30">
-          <h2 className={"mb-3 text-2xl font-semibold"}>Success</h2>
-          <p className={"m-0 max-w-[30ch] text-sm opacity-50"}>{success.toString()}</p>
-        </div>
-
-        <div className="px-5 py-4 transition-colors border border-transparent rounded-lg group hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800 hover:dark:bg-opacity-30">
-          <h2 className={"mb-3 text-2xl font-semibold"}>Limit </h2>
-          <p className={"m-0 max-w-[30ch] text-sm opacity-50"}>{limit}</p>
-        </div>
-
-        <div className="px-5 py-4 transition-colors border border-transparent rounded-lg group hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30">
-          <h2 className={"mb-3 text-2xl font-semibold"}>Remaining</h2>
-          <p className={"m-0 max-w-[30ch] text-sm opacity-50"}>{remaining}</p>
-        </div>
-
-        <div className="px-5 py-4 transition-colors border border-transparent rounded-lg group hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30">
-          <h2 className={"mb-3 text-2xl font-semibold"}>Reset</h2>
-          <p className={"m-0 max-w-[30ch] text-sm opacity-50"}>{new Date(reset).toUTCString()}</p>
-        </div>
-      </div>
-    </main>
-  );
-}

package/examples/with-vercel-kv/next.config.js

@@ -1,8 +0,0 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  experimental: {
-    appDir: true,
-  },
-};
-
-module.exports = nextConfig;

package/examples/with-vercel-kv/package.json

@@ -1,25 +0,0 @@
-{
-  "name": "with-vercel-kv",
-  "version": "0.1.0",
-  "private": true,
-  "scripts": {
-    "dev": "next dev",
-    "build": "next build",
-    "start": "next start",
-    "lint": "next lint"
-  },
-  "dependencies": {
-    "@types/node": "20.1.2",
-    "@types/react": "18.2.6",
-    "@types/react-dom": "18.2.4",
-    "@upstash/ratelimit": "^0.4.3",
-    "@vercel/kv": "^0.1.2",
-    "autoprefixer": "10.4.14",
-    "next": "13.4.1",
-    "postcss": "8.4.23",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "tailwindcss": "3.3.2",
-    "typescript": "5.0.4"
-  }
-}

package/examples/with-vercel-kv/postcss.config.js

@@ -1,6 +0,0 @@
-module.exports = {
-  plugins: {
-    tailwindcss: {},
-    autoprefixer: {},
-  },
-};

package/examples/with-vercel-kv/public/next.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>

package/examples/with-vercel-kv/public/vercel.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 283 64"><path fill="black" d="M141 16c-11 0-19 7-19 18s9 18 20 18c7 0 13-3 16-7l-7-5c-2 3-6 4-9 4-5 0-9-3-10-7h28v-3c0-11-8-18-19-18zm-9 15c1-4 4-7 9-7s8 3 9 7h-18zm117-15c-11 0-19 7-19 18s9 18 20 18c6 0 12-3 16-7l-8-5c-2 3-5 4-8 4-5 0-9-3-11-7h28l1-3c0-11-8-18-19-18zm-10 15c2-4 5-7 10-7s8 3 9 7h-19zm-39 3c0 6 4 10 10 10 4 0 7-2 9-5l8 5c-3 5-9 8-17 8-11 0-19-7-19-18s8-18 19-18c8 0 14 3 17 8l-8 5c-2-3-5-5-9-5-6 0-10 4-10 10zm83-29v46h-9V5h9zM37 0l37 64H0L37 0zm92 5-27 48L74 5h10l18 30 17-30h10zm59 12v10l-3-1c-6 0-10 4-10 10v15h-9V17h9v9c0-5 6-9 13-9z"/></svg>

package/examples/with-vercel-kv/tailwind.config.js

@@ -1,17 +0,0 @@
-/** @type {import('tailwindcss').Config} */
-module.exports = {
-  content: [
-    "./pages/**/*.{js,ts,jsx,tsx,mdx}",
-    "./components/**/*.{js,ts,jsx,tsx,mdx}",
-    "./app/**/*.{js,ts,jsx,tsx,mdx}",
-  ],
-  theme: {
-    extend: {
-      backgroundImage: {
-        "gradient-radial": "radial-gradient(var(--tw-gradient-stops))",
-        "gradient-conic": "conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))",
-      },
-    },
-  },
-  plugins: [],
-};

package/examples/with-vercel-kv/tsconfig.json

@@ -1,28 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "noEmit": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "jsx": "preserve",
-    "incremental": true,
-    "plugins": [
-      {
-        "name": "next"
-      }
-    ],
-    "paths": {
-      "@/*": ["./*"]
-    }
-  },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
-}

package/src/analytics.test.ts

@@ -1,23 +0,0 @@
-import { expect, test } from "bun:test";
-import crypto from "node:crypto";
-import { Redis } from "@upstash/redis";
-import { Analytics } from "./analytics";
-
-test("analytics", async () => {
-  const redis = Redis.fromEnv();
-  const a = new Analytics({ redis, prefix: crypto.randomUUID() });
-  const time = Date.now();
-  for (let i = 0; i < 20; i++) {
-    await a.record({
-      identifier: "id",
-      success: true,
-      time,
-    });
-  }
-
-  const usage = await a.getUsage(Date.now() - 1000 * 60 * 60 * 24);
-  expect(Object.entries(usage).length).toBe(1);
-  expect(Object.keys(usage)).toContain("id");
-  expect(usage.id.success).toBe(20);
-  expect(usage.id.blocked).toBe(0);
-});

package/src/analytics.ts

@@ -1,92 +0,0 @@
-import { Analytics as CoreAnalytics } from "@upstash/core-analytics";
-import type { Redis } from "./types";
-
-export type Geo = {
-  country?: string;
-  city?: string;
-  region?: string;
-  ip?: string;
-};
-export type Event = Geo & {
-  identifier: string;
-  time: number;
-  success: boolean;
-};
-
-export type AnalyticsConfig = {
-  redis: Redis;
-  prefix?: string;
-};
-
-/**
- * The Analytics package is experimental and can change at any time.
- */
-export class Analytics {
-  private readonly analytics: CoreAnalytics;
-  private readonly table = "events";
-
-  constructor(config: AnalyticsConfig) {
-    this.analytics = new CoreAnalytics({
-      // @ts-expect-error we need to fix the types in core-analytics, it should only require the methods it needs, not the whole sdk
-      redis: config.redis,
-      window: "1h",
-      prefix: config.prefix ?? "@upstash/ratelimit",
-      retention: "90d",
-    });
-  }
-
-  /**
-   * Try to extract the geo information from the request
-   *
-   * This handles Vercel's `req.geo` and  and Cloudflare's `request.cf` properties
-   * @param req
-   * @returns
-   */
-  public extractGeo(req: { geo?: Geo; cf?: Geo }): Geo {
-    if (typeof req.geo !== "undefined") {
-      return req.geo;
-    }
-    if (typeof req.cf !== "undefined") {
-      return req.cf;
-    }
-
-    return {};
-  }
-
-  public async record(event: Event): Promise<void> {
-    await this.analytics.ingest(this.table, event);
-  }
-
-  async series<TFilter extends keyof Omit<Event, "time">>(
-    filter: TFilter,
-    cutoff: number,
-  ): Promise<({ time: number } & Record<string, number>)[]> {
-    const records = await this.analytics.query(this.table, {
-      filter: [filter],
-      range: [cutoff, Date.now()],
-    });
-    return records;
-  }
-  public async getUsage(cutoff = 0): Promise<Record<string, { success: number; blocked: number }>> {
-    const records = await this.analytics.aggregateBy(this.table, "identifier", {
-      range: [cutoff, Date.now()],
-    });
-    const usage = {} as Record<string, { success: number; blocked: number }>;
-    for (const bucket of records) {
-      for (const [k, v] of Object.entries(bucket)) {
-        if (k === "time") {
-          continue;
-        }
-
-        if (!usage[k]) {
-          usage[k] = { success: 0, blocked: 0 };
-        }
-        // @ts-ignore
-        usage[k].success += v.true ?? 0;
-        // @ts-ignore
-        usage[k].blocked += v.false ?? 0;
-      }
-    }
-    return usage;
-  }
-}

package/src/blockUntilReady.test.ts

@@ -1,56 +0,0 @@
-import { describe, expect, test } from "bun:test";
-import crypto from "node:crypto";
-import { Redis } from "@upstash/redis";
-import { Ratelimit } from "./index";
-
-const redis = Redis.fromEnv();
-
-const metrics: Record<string | symbol, number> = {};
-
-const spy = new Proxy(redis, {
-  get: (target, prop) => {
-    if (typeof metrics[prop] === "undefined") {
-      metrics[prop] = 0;
-    }
-    metrics[prop]++;
-    // @ts-ignore - we don't care about the types here
-    return target[prop];
-  },
-});
-const limiter = new Ratelimit({
-  redis: spy,
-  limiter: Ratelimit.fixedWindow(5, "5 s"),
-});
-
-describe("blockUntilReady", () => {
-  test("reaching the timeout", async () => {
-    const id = crypto.randomUUID();
-
-    // Use up all tokens in the current window
-    for (let i = 0; i < 15; i++) {
-      await limiter.limit(id);
-    }
-
-    const start = Date.now();
-    const res = await limiter.blockUntilReady(id, 1200);
-    expect(res.success).toBe(false);
-    expect(start + 1000).toBeLessThanOrEqual(Date.now());
-    await res.pending;
-  }, 20000);
-
-  test("resolving before the timeout", async () => {
-    const id = crypto.randomUUID();
-
-    // Use up all tokens in the current window
-    // for (let i = 0; i < 4; i++) {
-    //   await limiter.limit(id);
-    // }
-
-    const start = Date.now();
-    const res = await limiter.blockUntilReady(id, 1000);
-    expect(res.success).toBe(true);
-    expect(start + 1000).toBeGreaterThanOrEqual(Date.now());
-
-    await res.pending;
-  }, 20000);
-});

package/src/cache.test.ts

@@ -1,41 +0,0 @@
-import { expect, test } from "bun:test";
-import { Redis } from "@upstash/redis";
-import { Ratelimit } from "./index";
-
-test("ephemeral cache", async () => {
-  const maxTokens = 10;
-  const redis = Redis.fromEnv();
-
-  const metrics: Record<string | symbol, number> = {};
-
-  const spy = new Proxy(redis, {
-    get: (target, prop) => {
-      if (typeof metrics[prop] === "undefined") {
-        metrics[prop] = 0;
-      }
-      metrics[prop]++;
-      // @ts-ignore - we don't care about the types here
-      return target[prop];
-    },
-  });
-  const ratelimit = new Ratelimit({
-    // @ts-ignore - we don't care about the types here
-    redis: spy,
-    limiter: Ratelimit.tokenBucket(maxTokens, "5 s", maxTokens),
-    ephemeralCache: new Map(),
-  });
-
-  let passes = 0;
-
-  for (let i = 0; i <= 20; i++) {
-    const { success } = await ratelimit.limit("id");
-    if (success) {
-      passes++;
-    }
-  }
-
-  expect(passes).toBeLessThanOrEqual(10);
-  expect(metrics.eval).toBeLessThanOrEqual(10);
-
-  await new Promise((r) => setTimeout(r, 5000));
-}, 10000);

package/src/cache.ts

@@ -1,43 +0,0 @@
-import { EphemeralCache } from "./types";
-
-export class Cache implements EphemeralCache {
-  /**
-   * Stores identifier -> reset (in milliseconds)
-   */
-  private readonly cache: Map<string, number>;
-
-  constructor(cache: Map<string, number>) {
-    this.cache = cache;
-  }
-
-  public isBlocked(identifier: string): { blocked: boolean; reset: number } {
-    if (!this.cache.has(identifier)) {
-      return { blocked: false, reset: 0 };
-    }
-    const reset = this.cache.get(identifier)!;
-    if (reset < Date.now()) {
-      this.cache.delete(identifier);
-      return { blocked: false, reset: 0 };
-    }
-
-    return { blocked: true, reset: reset };
-  }
-
-  public blockUntil(identifier: string, reset: number): void {
-    this.cache.set(identifier, reset);
-  }
-
-  public set(key: string, value: number): void {
-    this.cache.set(key, value);
-  }
-  public get(key: string): number | null {
-    return this.cache.get(key) || null;
-  }
-
-  public incr(key: string): number {
-    let value = this.cache.get(key) ?? 0;
-    value += 1;
-    this.cache.set(key, value);
-    return value;
-  }
-}

package/src/duration.test.ts

@@ -1,23 +0,0 @@
-import { describe, expect, it } from "bun:test";
-import { ms } from "./duration";
-
-describe("ms", () => {
-  it("should return the correct number of milliseconds for a given duration", () => {
-    expect(ms("100ms")).toBe(100);
-    expect(ms("2s")).toBe(2000);
-    expect(ms("3m")).toBe(180000);
-    expect(ms("4h")).toBe(14400000);
-    expect(ms("5d")).toBe(432000000);
-    expect(ms("10ms")).toBe(10);
-  });
-  describe("with space", () => {
-    it("should return the correct number of milliseconds for a given duration", () => {
-      expect(ms("100 ms")).toBe(100);
-      expect(ms("2 s")).toBe(2000);
-      expect(ms("3 m")).toBe(180000);
-      expect(ms("4 h")).toBe(14400000);
-      expect(ms("5 d")).toBe(432000000);
-      expect(ms("10 ms")).toBe(10);
-    });
-  });
-});

package/src/duration.ts

@@ -1,30 +0,0 @@
-type Unit = "ms" | "s" | "m" | "h" | "d";
-export type Duration = `${number} ${Unit}` | `${number}${Unit}`;
-
-/**
- * Convert a human readable duration to milliseconds
- */
-export function ms(d: Duration): number {
-  const match = d.match(/^(\d+)\s?(ms|s|m|h|d)$/);
-  if (!match) {
-    throw new Error(`Unable to parse window size: ${d}`);
-  }
-  const time = parseInt(match[1]);
-  const unit = match[2] as Unit;
-
-  switch (unit) {
-    case "ms":
-      return time;
-    case "s":
-      return time * 1000;
-    case "m":
-      return time * 1000 * 60;
-    case "h":
-      return time * 1000 * 60 * 60;
-    case "d":
-      return time * 1000 * 60 * 60 * 24;
-
-    default:
-      throw new Error(`Unable to parse window size: ${d}`);
-  }
-}

package/src/index.ts

@@ -1,17 +0,0 @@
-import { Analytics } from "./analytics";
-import type { AnalyticsConfig } from "./analytics";
-import { MultiRegionRatelimit } from "./multi";
-import type { MultiRegionRatelimitConfig } from "./multi";
-import { RegionRatelimit as Ratelimit } from "./single";
-import type { RegionRatelimitConfig as RatelimitConfig } from "./single";
-import type { Algorithm } from "./types";
-
-export {
-  Ratelimit,
-  RatelimitConfig,
-  MultiRegionRatelimit,
-  MultiRegionRatelimitConfig,
-  Algorithm,
-  Analytics,
-  AnalyticsConfig,
-};