@arcjet/astro 1.3.1 → 1.5.0

package/README.md

@@ -18,11 +18,31 @@
 
 [Arcjet][arcjet] is the runtime security platform that ships with your AI code. Stop bots and automated attacks from burning your AI budget, leaking data, or misusing tools with Arcjet's AI security building blocks. Every feature works with any Astro application.
 
-This is the [Arcjet][arcjet] SDK for [Astro][astro].
+This is the [Arcjet][arcjet] SDK for [Astro][astro] **request protection** —
+use it to protect HTTP route handlers and API endpoints. If you need to protect
+AI agent tool calls, MCP server handlers, or background jobs (anything without
+an HTTP request), see [`@arcjet/guard`](https://github.com/arcjet/arcjet-js/tree/main/arcjet-guard).
 
 ## Getting started
 
-1. Get your API key at [`app.arcjet.com`](https://app.arcjet.com)
+### Quick setup with an AI agent
+
+1. Log in with the CLI:
+   ```sh
+   npx @arcjet/cli auth login
+   ```
+2. Install the request protection skill to give your coding agent the docs it needs:
+   ```sh
+   npx skills add arcjet/skills --skill add-request-protection
+   ```
+3. Tell your agent what to protect — it handles the rest.
+
+### Manual setup
+
+1. **Log in** with the CLI (or at [`app.arcjet.com`](https://app.arcjet.com?utm_campaign=arcjet-js)):
+   ```sh
+   npx @arcjet/cli auth login
+   ```
 2. `npm install @arcjet/astro`
 3. Set `ARCJET_KEY=ajkey_yourkey` in your environment
 4. Add Arcjet to your app — see the [quick start](#quick-start) below
@@ -34,6 +54,23 @@ This is the [Arcjet][arcjet] SDK for [Astro][astro].
 
 ## Features
 
+All features below are available with `@arcjet/astro` for request protection.
+For guard protection (tool calls, MCP servers, queues) see
+[`@arcjet/guard`](https://github.com/arcjet/arcjet-js/tree/main/arcjet-guard).
+
+| Feature                         | `@arcjet/astro` | `@arcjet/guard` |
+| ------------------------------- | :-------------: | :-------------: |
+| Rate Limiting                   |       ✅        |       ✅        |
+| Prompt Injection Detection      |       ✅        |       ✅        |
+| Sensitive Information Detection |       ✅        |       ✅        |
+| Bot Protection                  |       ✅        |        —        |
+| Shield WAF                      |       ✅        |        —        |
+| Email Validation                |       ✅        |        —        |
+| Signup Form Protection          |       ✅        |        —        |
+| Request Filters                 |       ✅        |        —        |
+| IP Analysis                     |       ✅        |        —        |
+| Custom Rules                    |        —        |       ✅        |
+
 - 🔒 [Prompt Injection Detection](#prompt-injection-detection) — detect and block
   prompt injection attacks before they reach your LLM.
 - 🤖 [Bot Protection](#bot-protection) — stop scrapers, credential stuffers,
@@ -142,7 +179,7 @@ For the full reference, see the [Arcjet Astro SDK docs][arcjet-reference-astro].
 
 Detect and block prompt injection attacks — attempts to override your AI
 model's instructions — before they reach your model. Pass the user's message
-via `detectPromptInjectionMessage` on each `protect()` call. Tune sensitivity with the `threshold` parameter (0.0–1.0, default 0.5) — higher values are more conservative.
+via `detectPromptInjectionMessage` on each `protect()` call.
 
 Configure in `astro.config.mjs`:
 
@@ -156,7 +193,6 @@ export default defineConfig({
       rules: [
         detectPromptInjection({
           mode: "LIVE", // Blocks requests. Use "DRY_RUN" to log only
-          threshold: 0.5, // Score above which requests are blocked (default: 0.5)
         }),
       ],
     }),

package/index.d.ts

@@ -1,5 +1,8 @@
 import type { BotOptions, DetectPromptInjectionOptions, EmailOptions, FilterOptions, FixedWindowRateLimitOptions, ProtectSignupOptions, SensitiveInfoOptions, ShieldOptions, SlidingWindowRateLimitOptions, TokenBucketRateLimitOptions } from "arcjet";
+import type { ProxyService } from "@arcjet/ip";
 import type { AstroIntegration } from "astro";
+export { cloudflare } from "@arcjet/ip";
+export type { ProxyService } from "@arcjet/ip";
 type IntegrationRule<Characteristics extends readonly string[]> = {
     type: "shield";
     options: ShieldOptions;
@@ -58,8 +61,12 @@ export type ArcjetOptions<Characteristics extends readonly string[]> = {
     /**
      * IP addresses and CIDR ranges of trusted load balancers and proxies
      * (optional, example: `["100.100.100.100", "100.100.100.0/24"]`).
+     *
+     * Proxy services such as {@linkcode cloudflare} can also be included to read
+     * the real client IP from a service-specific header when the request comes
+     * from that service.
      */
-    proxies?: string[];
+    proxies?: Array<string | ProxyService>;
 };
 /**
  * Arcjet Shield WAF rule.
@@ -355,4 +362,3 @@ export declare function createRemoteClient(options?: RemoteClientOptions | undef
  *   Astro integration of Arcjet.
  */
 export default function arcjet<Characteristics extends readonly string[]>(options?: ArcjetOptions<Characteristics>): AstroIntegration;
-export {};

package/index.js

@@ -1,9 +1,20 @@
 import { z } from 'astro/zod';
 import fs from 'node:fs/promises';
+export { cloudflare } from '@arcjet/ip';
 
 const resolvedVirtualClientId = "\0ARCJET_VIRTUAL_CLIENT";
 const validateMode = z.enum(["LIVE", "DRY_RUN"]);
-const validateProxies = z.array(z.string());
+// A proxy service (such as the one created by `cloudflare()`) is a plain,
+// JSON-serializable object, so it survives being injected into the generated
+// client config. Ranges must be strings here because parsed `Cidr` objects
+// would not serialize; `findIp` parses these strings at runtime.
+const validateProxyService = z.object({
+    kind: z.literal("service"),
+    name: z.string(),
+    ranges: z.array(z.string()),
+    clientIp: z.array(z.object({ header: z.string(), format: z.enum(["ip", "ips"]) })),
+});
+const validateProxies = z.array(z.union([z.string(), validateProxyService]));
 const validateCharacteristics = z.array(z.string());
 const validateClientOptions = z
     .object({

package/internal.d.ts

@@ -1,4 +1,5 @@
 import type { ArcjetDecision, ArcjetOptions as CoreOptions, ArcjetRule, Primitive, Product, ExtraProps, CharacteristicProps } from "arcjet";
+import { type ProxyService } from "@arcjet/ip";
 export * from "arcjet";
 type Simplify<T> = {
     [KeyType in keyof T]: T[KeyType];
@@ -59,8 +60,12 @@ export type ArcjetOptions<Rules extends [...Array<Primitive | Product>], Charact
     /**
      * IP addresses and CIDR ranges of trusted load balancers and proxies
      * (optional, example: `["100.100.100.100", "100.100.100.0/24"]`).
+     *
+     * Proxy services such as {@linkcode cloudflare} can also be included to read
+     * the real client IP from a service-specific header when the request comes
+     * from that service.
      */
-    proxies?: Array<string>;
+    proxies?: Array<string | ProxyService>;
 }>;
 /**
  * Instance of the Astro integration of Arcjet.

package/internal.js

@@ -1,7 +1,7 @@
 import core__default from 'arcjet';
 export * from 'arcjet';
 import { readBodyWeb } from '@arcjet/body';
-import { parseProxy, findIp } from '@arcjet/ip';
+import { parseProxies, findIp } from '@arcjet/ip';
 import { ArcjetHeaders } from '@arcjet/headers';
 import { logLevel, isDevelopment, baseUrl, platform } from '@arcjet/env';
 import { Logger } from '@arcjet/logger';
@@ -40,7 +40,7 @@ function createRemoteClient(options) {
     // Transport is the HTTP client that the client uses to make requests.
     const transport = createTransport(url);
     const sdkStack = "ASTRO";
-    const sdkVersion = "1.3.1";
+    const sdkVersion = "1.5.0";
     return createClient({
         transport,
         baseUrl: url,
@@ -69,7 +69,7 @@ function createArcjetClient(options) {
             level: logLevel(env),
         });
     const proxies = Array.isArray(options.proxies)
-        ? options.proxies.map(parseProxy)
+        ? parseProxies(options.proxies)
         : undefined;
     if (isDevelopment(process.env)) {
         log.warn("Arcjet will use 127.0.0.1 when missing public IP address in development mode");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/astro",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "Arcjet runtime security SDK for Astro — bot protection, rate limiting, prompt injection detection, PII blocking, and WAF",
   "keywords": [
     "ai",
@@ -58,24 +58,24 @@
     "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {
-    "@arcjet/body": "1.3.1",
-    "@arcjet/env": "1.3.1",
-    "@arcjet/headers": "1.3.1",
-    "@arcjet/ip": "1.3.1",
-    "@arcjet/logger": "1.3.1",
-    "@arcjet/protocol": "1.3.1",
-    "@arcjet/transport": "1.3.1",
-    "arcjet": "1.3.1"
+    "@arcjet/body": "1.5.0",
+    "@arcjet/env": "1.5.0",
+    "@arcjet/headers": "1.5.0",
+    "@arcjet/ip": "1.5.0",
+    "@arcjet/logger": "1.5.0",
+    "@arcjet/protocol": "1.5.0",
+    "@arcjet/transport": "1.5.0",
+    "arcjet": "1.5.0"
   },
   "peerDependencies": {
     "astro": "^5.9.3 || ^6.0.0"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.3.1",
-    "@arcjet/rollup-config": "1.3.1",
-    "@rollup/wasm-node": "4.59.0",
-    "astro": "6.1.2",
-    "eslint": "9.39.3",
+    "@arcjet/eslint-config": "1.5.0",
+    "@arcjet/rollup-config": "1.5.0",
+    "@rollup/wasm-node": "4.61.0",
+    "astro": "6.1.10",
+    "eslint": "9.39.4",
     "typescript": "5.9.3"
   },
   "publishConfig": {