@convex-dev/rate-limiter/dist/commonjs/component/public.js

A rate limiter component for Convex. Define and use application-layer rate limits. Type-safe, transactional, fair, safe, and configurable sharding to scale.

import { v } from "convex/values";
import { mutation, query } from "./_generated/server.js";
import { rateLimitArgs, rateLimitReturns } from "../shared.js";
import { checkRateLimitOrThrow } from "./internal.js";
export const rateLimit = mutation({
    args: rateLimitArgs,
    returns: rateLimitReturns,
    handler: async (ctx, args) => {
        const { status, updates } = await checkRateLimitOrThrow(ctx.db, args);
        for (const { value, ts, existing, shard } of updates) {
            if (existing) {
                await ctx.db.patch(existing._id, { ts, value });
            }
            else {
                const { name, key: optionalKey } = args;
                const key = optionalKey;
                await ctx.db.insert("rateLimits", { name, key, ts, value, shard });
            }
        }
        return status;
    },
});
export const checkRateLimit = query({
    args: rateLimitArgs,
    returns: rateLimitReturns,
    handler: async (ctx, args) => {
        const { status } = await checkRateLimitOrThrow(ctx.db, args);
        return status;
    },
});
export const resetRateLimit = mutation({
    args: {
        name: v.string(),
        key: v.optional(v.string()),
    },
    returns: v.null(),
    handler: async (ctx, args) => {
        const allShards = await ctx.db
            .query("rateLimits")
            .withIndex("name", (q) => q.eq("name", args.name).eq("key", args.key))
            .collect();
        for (const shard of allShards) {
            await ctx.db.delete(shard._id);
        }
    },
});
//# sourceMappingURL=public.js.map