@arcjet/decorate

@arcjet/decorate

Arcjet utilities for decorating responses with information.

Installation

npm install -S @arcjet/decorate

Example

import arcjet, { fixedWindow } from "@arcjet/next";
import { setRateLimitHeaders } from "@arcjet/decorate";
import { NextApiRequest, NextApiResponse } from "next";

const aj = arcjet({
  key: process.env.ARCJET_KEY!, // Get your site key from https://app.arcjet.com
  rules: [
    // Create a fixed window rate limit. Other algorithms are supported.
    fixedWindow({
      mode: "LIVE", // will block requests. Use "DRY_RUN" to log only
      window: "1m", // 1 min fixed window
      max: 1, // allow a single request
    }),
  ],
});

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse,
) {
  const decision = await aj.protect(req);

  setRateLimitHeaders(res, decision);

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

  res.status(200).json({ name: "Hello world" });
}

License

Licensed under the Apache License, Version 2.0.

Changelog

1.0.0-beta.2 (2025-02-04)

🚀 New Features

• env: Support MODE environment variable for isDevelopment detection (#3012) (f3a45a7)
• Implement Astro integration (#2992) (a48eea8), closes #1075
• nestjs: Allow NestJS v11 as peerDependency (#3042) (4a75963), closes #2921
• redact: Pre-compile WebAssembly on module load (#3037) (c12bec5)

🪲 Bug Fixes

• analyze: Always lowercase headers and iterate in insertion order (#2865) (a9af1e4)
• arcjet: Ensure Characteristics are readonly type on protect signup options (#3013) (1f16a99)
• protocol: Double timeout when email rule configured (#2934) (23f9a9e), closes #1697

🧹 Miscellaneous Chores

• ci: Add dependabot for Astro example (#3068) (d4d8f82)
• ci: Avoid upgrading Tailwind where it breaks things (#3081) (5c25abe)
• ci: Restrict tailwind-merge where tailwind restricted (#3089) (a3437a5)
• docs: Add a link to the Redact reference page (#3038) (6095b6a)
• Refresh root & Next.js READMEs (#3066) (57a38d7)
• rollup-config: Consolidate wasmToModule plugin (#3039) (c3b8e36)