arcjet

arcjet

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 TypeScript and JavaScript SDK core.

Getting started

Visit docs.arcjet.com to get started.

Generally, you'll want to use the Arcjet SDK for your specific framework, such as @arcjet/next for Next.js. However, this package can be used to interact with Arcjet if your framework does not have an integration.

Installation

npm install -S arcjet

Example

import http from "http";
import arcjet, { createRemoteClient } from "arcjet";
import { baseUrl } from "@arcjet/env";
import { createConnectTransport } from "@connectrpc/connect-node";

const aj = arcjet({
  // Get your site key from https://app.arcjet.com
  // and set it as an environment variable rather than hard coding.
  // See: https://www.npmjs.com/package/dotenv
  key: process.env.ARCJET_KEY,
  rules: [],
  client: createRemoteClient({
    transport: createConnectTransport({
      baseUrl: baseUrl(process.env),
      httpVersion: "2",
    }),
  }),
});

const server = http.createServer(async function (
  req: http.IncomingMessage,
  res: http.ServerResponse,
) {
  // Any sort of additional context that might want to be included for the
  // execution of `protect()`. This is mostly only useful for writing adapters.
  const ctx = {};

  // Construct an object with Arcjet request details
  const path = new URL(req.url || "", `http://${req.headers.host}`);
  const details = {
    ip: req.socket.remoteAddress,
    method: req.method,
    host: req.headers.host,
    path: path.pathname,
  };

  const decision = await aj.protect(ctx, details);
  console.log(decision);

  if (decision.isDenied()) {
    res.writeHead(403, { "Content-Type": "application/json" });
    res.end(JSON.stringify({ error: "Forbidden" }));
  } else {
    res.writeHead(200, { "Content-Type": "application/json" });
    res.end(JSON.stringify({ data: "Hello World!" }));
  }
});

server.listen(8000);

API

Reference documentation is available at docs.arcjet.com.

License

Licensed under the Apache License, Version 2.0.

Changelog

1.0.0-alpha.24 (2024-09-05)

⚠ BREAKING CHANGES

• Rework bot detection rule with allow/deny configuration (#1437)

🚀 New Features

• Rework bot detection rule with allow/deny configuration (#1437) (eef18e3)

🧹 Miscellaneous Chores

• examples: Correct some usage mistakes in sensitive info examples (#1503) (1286280)