@arcjet/next

@arcjet/next

Arcjet helps developers protect their apps in just a few lines of code. Implement rate limiting, bot protection, email verification, and defense against common attacks.

This is the Arcjet SDK for the Next.js framework.

Looking for our Node.js SDK? Check out the @arcjet/node package.

Getting started

Visit the quick start guide to get started.

Example app

Try an Arcjet protected app live at https://example.arcjet.com (source code).

Installation

npm install -S @arcjet/next

Rate limit example

The Arcjet rate limit example below applies a token bucket rate limit rule to a route where we identify the user based on their ID e.g. if they are logged in. The bucket is configured with a maximum capacity of 10 tokens and refills by 5 tokens every 10 seconds. Each request consumes 5 tokens.

See the Arcjet rate limit documentation for details.

import arcjet, { tokenBucket } from "@arcjet/next";
import { NextResponse } from "next/server";

const aj = arcjet({
  key: process.env.ARCJET_KEY!, // Get your site key from https://app.arcjet.com
  rules: [
    // Create a token bucket rate limit. Other algorithms are supported.
    tokenBucket({
      mode: "LIVE", // will block requests. Use "DRY_RUN" to log only
      characteristics: ["userId"], // track requests by a custom user ID
      refillRate: 5, // refill 5 tokens per interval
      interval: 10, // refill every 10 seconds
      capacity: 10, // bucket maximum capacity of 10 tokens
    }),
  ],
});

export async function GET(req: Request) {
  const userId = "user123"; // Replace with your authenticated user ID
  const decision = await aj.protect(req, { userId, requested: 5 }); // Deduct 5 tokens from the bucket
  console.log("Arcjet decision", decision);

  if (decision.isDenied()) {
    return NextResponse.json(
      { error: "Too Many Requests", reason: decision.reason },
      { status: 429 },
    );
  }

  return NextResponse.json({ message: "Hello world" });
}

Shield example

Arcjet Shield protects your application against common attacks, including the OWASP Top 10. You can run Shield on every request with negligible performance impact.

See the Arcjet Shield documentation for details.

import arcjet, { shield } from "@arcjet/next";
import { NextResponse } from "next/server";

const aj = arcjet({
  key: process.env.ARCJET_KEY, // Get your site key from https://app.arcjet.com
  rules: [
    shield({
      mode: "LIVE", // will block requests. Use "DRY_RUN" to log only
    }),
  ],
});

export async function GET(req: Request) {
  const decision = await aj.protect(req);

  if (decision.isDenied()) {
    return NextResponse.json(
      { error: "Forbidden", reason: decision.reason },
      { status: 403 },
    );
  }

  return NextResponse.json({ message: "Hello world" });
}

API

Reference documentation is available at docs.arcjet.com.

License

Licensed under the Apache License, Version 2.0.

Changelog

1.0.0-alpha.21 (2024-08-05)

🚀 New Features

• Abstract transports into package to leverage conditional exports (#1221) (27776f7)
• Attempt to warm http2 connection upon SDK startup (#1201) (a5c2571)

🧹 Miscellaneous Chores

• ci: Change the dependabot commit prefix for Actions PRs (#1231) (4dac6d5)
• ci: Ignore typescript-eslint 8 until we upgrade to eslint 9 (#1263) (b089de2), closes #539
• ci: Leverage Dependabot to update our GitHub Actions (#1222) (ffde70a)
• ci: Switch release-please-action location & update to latest version (#1229) (e44d81d)
• deps: bump actions/checkout from 3 to 4 (#1226) (7d5242c)
• deps: bump step-security/harden-runner from 2.7.0 to 2.9.0 (#1225) (76755e1)
• examples: Ensure bun examples have updated dependencies (#1213) (e766029)
• Remove Dependencies section from release notes (#1211) (1708f6a)