@arcjet/bun 1.9.0 → 1.10.0-rc.0

package/README.md

@@ -16,13 +16,17 @@
   </a>
 </p>
 
-[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 Bun application.
+[Arcjet][arcjet] is the runtime security platform that ships in your AI code. Detect prompt injection, authorize agent tool calls, redact sensitive data, and block bots and abuse. Real-time security building blocks you call inside your app, before an action happens.
 
 This is the [Arcjet][arcjet] SDK for [Bun][bun-sh] **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).
 
+## Why Arcjet?
+
+Your app's AI features and agents take real actions, calling tools, reading data, hitting APIs. Arcjet runs inside that code and lets you enforce security on each action in real time, then audit what happened
+
 ## Getting started
 
 ### Quick setup with an AI agent

package/dist/index.d.ts

@@ -1,134 +1,132 @@
 import { ProxyService, ProxyService as ProxyService$1, cloudflare } from "@arcjet/ip";
-import { ArcjetDecision, ArcjetOptions as ArcjetOptions$1, ArcjetRule, CharacteristicProps, ExtraProps, Primitive, Product } from "arcjet";
+import { ArcjetDecision, ArcjetMetadata, ArcjetOptions as ArcjetOptions$1, ArcjetRule, CharacteristicProps, ExtraProps, Primitive, Product } from "arcjet";
 import { createClient } from "@arcjet/protocol/client.js";
 import { Server } from "bun";
 export * from "arcjet";
-
 //#region src/index.d.ts
-type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
-declare const emptyObjectSymbol: unique symbol;
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType]; } & {};
 type PlainObject = {
   [key: string]: unknown;
 };
 /**
-* Dynamically generate whether zero or one `properties` object must or can be passed.
-*/
-type MaybeProperties<T> = { [P in keyof T]?: T[P] } extends T ? T extends {
-  [emptyObjectSymbol]?: never;
-} ? [] : [properties?: T] : [properties: T];
+ * Dynamically generate whether zero or one `properties` object must or can be passed.
+ */
+type MaybeProperties<T> = { [P in keyof T]?: T[P]; } extends T ? [properties?: T] : [properties: T];
 /**
-* Configuration for {@linkcode createRemoteClient}.
-*/
+ * Configuration for {@linkcode createRemoteClient}.
+ */
 type RemoteClientOptions = {
   /**
-  * Base URI for HTTP requests to Decide API (optional).
-  *
-  * Defaults to the environment variable `ARCJET_BASE_URL` (if that value
-  * is known and allowed) and the standard production API otherwise.
-  */
+   * Base URI for HTTP requests to Decide API (optional).
+   *
+   * Defaults to the environment variable `ARCJET_BASE_URL` (if that value
+   * is known and allowed) and the standard production API otherwise.
+   */
   baseUrl?: string;
   /**
-  * Timeout in milliseconds for the Decide API (optional).
-  *
-  * Defaults to `500` in production and `1000` in development.
-  */
+   * Timeout in milliseconds for the Decide API (optional).
+   *
+   * Defaults to `500` in production and `1000` in development.
+   */
   timeout?: number;
 };
 /**
-* Create a remote client.
-*
-* @param options
-*   Configuration (optional).
-* @returns
-*   Client.
-*/
+ * Create a remote client.
+ *
+ * @param options
+ *   Configuration (optional).
+ * @returns
+ *   Client.
+ */
 declare function createRemoteClient(options?: RemoteClientOptions): ReturnType<typeof createClient>;
 /**
-* Configuration for the Bun integration of Arcjet.
-*
-* @template Rules
-*   List of rules.
-* @template Characteristics
-*   Characteristics to track a user by.
-*/
+ * Configuration for the Bun integration of Arcjet.
+ *
+ * @template Rules
+ *   List of rules.
+ * @template Characteristics
+ *   Characteristics to track a user by.
+ */
 type ArcjetOptions<Rules extends [...Array<Primitive | Product>], Characteristics extends readonly string[]> = Simplify<ArcjetOptions$1<Rules, Characteristics> & {
   /**
-  * 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.
-  */
+   * 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 | ProxyService$1>;
 }>;
 /**
-* Instance of the Bun integration of Arcjet.
-*
-* Primarily has a `protect()` method to make a decision about how a Bun request
-* should be handled.
-*
-* @template Props
-*   Configuration.
-*/
+ * Instance of the Bun integration of Arcjet.
+ *
+ * Primarily has a `protect()` method to make a decision about how a Bun request
+ * should be handled.
+ *
+ * @template Props
+ *   Configuration.
+ */
 interface ArcjetBun<Props extends PlainObject> {
   /**
-  * Make a decision about how to handle a request.
-  *
-  * This will analyze the request locally where possible and otherwise call
-  * the Arcjet decision API.
-  *
-  * @param ctx
-  *   Additional context for this function call.
-  * @param request
-  *   Details about the {@linkcode Request} that Arcjet needs to make a
-  *   decision.
-  * @param props
-  *   Additional properties required for running rules against a request.
-  * @returns
-  *   Promise that resolves to an {@linkcode ArcjetDecision} indicating
-  *   Arcjet’s decision about the request.
-  */
+   * Make a decision about how to handle a request.
+   *
+   * This will analyze the request locally where possible and otherwise call
+   * the Arcjet decision API.
+   *
+   * @param ctx
+   *   Additional context for this function call.
+   * @param request
+   *   Details about the {@linkcode Request} that Arcjet needs to make a
+   *   decision.
+   * @param props
+   *   Additional properties required for running rules against a request,
+   *   plus request-independent options such as `metadata`.
+   * @returns
+   *   Promise that resolves to an {@linkcode ArcjetDecision} indicating
+   *   Arcjet’s decision about the request.
+   */
   protect(request: Request, ...properties: MaybeProperties<Props & {
     correlationId?: string;
+    metadata?: ArcjetMetadata;
   }>): Promise<ArcjetDecision>;
   /**
-  * Augment the client with another rule.
-  *
-  * Useful for varying rules based on criteria in your handler such as
-  * different rate limit for logged in users.
-  *
-  * @template Rule
-  *   Type of rule.
-  * @param rule
-  *   Rule to add to Arcjet.
-  * @returns
-  *   Arcjet instance augmented with the given rule.
-  */
+   * Augment the client with another rule.
+   *
+   * Useful for varying rules based on criteria in your handler such as
+   * different rate limit for logged in users.
+   *
+   * @template Rule
+   *   Type of rule.
+   * @param rule
+   *   Rule to add to Arcjet.
+   * @returns
+   *   Arcjet instance augmented with the given rule.
+   */
   withRule<Rule extends ArcjetRule>(rule: Array<Rule>): ArcjetBun<Props & (Rule extends ArcjetRule<infer P> ? P : {})>;
   /**
-  * Wrap the Bun `fetch` handler to provide additional details when calling
-  * the `protect()` method.
-  *
-  * @param fetch
-  *   Original `fetch` from Bun.
-  * @returns
-  *   Wrapped `fetch` handler.
-  */
+   * Wrap the Bun `fetch` handler to provide additional details when calling
+   * the `protect()` method.
+   *
+   * @param fetch
+   *   Original `fetch` from Bun.
+   * @returns
+   *   Wrapped `fetch` handler.
+   */
   handler(fetch: (this: Server<any>, request: Request, server: Server<any>) => Response | Promise<Response>): (this: Server<any>, request: Request, server: Server<any>) => Response | Promise<Response>;
 }
 /**
-* Create a new Bun integration of Arcjet.
-*
-* @template Rules
-*   List of rules.
-* @template Characteristics
-*   Characteristics to track a user by.
-* @param options
-*   Configuration.
-* @returns
-*   Bun integration of Arcjet.
-*/
+ * Create a new Bun integration of Arcjet.
+ *
+ * @template Rules
+ *   List of rules.
+ * @template Characteristics
+ *   Characteristics to track a user by.
+ * @param options
+ *   Configuration.
+ * @returns
+ *   Bun integration of Arcjet.
+ */
 declare function arcjet<const Rules extends (Primitive | Product)[], const Characteristics extends readonly string[]>(options: ArcjetOptions<Rules, Characteristics>): ArcjetBun<ExtraProps<Rules> & CharacteristicProps<Characteristics>>;
 //#endregion
 export { ArcjetBun, ArcjetOptions, type ProxyService, RemoteClientOptions, cloudflare, createRemoteClient, arcjet as default };

package/dist/index.js

@@ -10,7 +10,7 @@ import { env } from "bun";
 export * from "arcjet";
 //#region src/index.ts
 /** SDK version. Updated by the release process. */
-const VERSION = "1.9.0";
+const VERSION = "1.10.0-rc.0";
 let warnedForAutomaticBodyRead = false;
 /**
 * Create a remote client.
@@ -80,7 +80,7 @@ function arcjet(options) {
 				return withClient(aj.withRule(rule));
 			},
 			async protect(request, props) {
-				const { correlationId, ...properties } = props ?? {};
+				const { correlationId, metadata, ...properties } = props ?? {};
 				const req = toArcjetRequest(request, properties || {});
 				const getBody = async () => {
 					if (request.bodyUsed) throw new Error("Cannot read body: already read");
@@ -97,7 +97,8 @@ function arcjet(options) {
 				};
 				return aj.protect({ getBody }, {
 					...req,
-					correlationId
+					correlationId,
+					metadata
 				});
 			},
 			handler(fetch) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/bun",
-  "version": "1.9.0",
+  "version": "1.10.0-rc.0",
   "description": "Arcjet runtime security SDK for Bun — bot protection, rate limiting, prompt injection detection, PII blocking, and WAF",
   "keywords": [
     "ai",
@@ -55,23 +55,23 @@
   },
   "scripts": {
     "build": "tsdown",
-    "typecheck": "tsgo --noEmit",
+    "typecheck": "tsc --noEmit",
     "test": "npm run build"
   },
   "dependencies": {
-    "@arcjet/body": "1.9.0",
-    "@arcjet/env": "1.9.0",
-    "@arcjet/headers": "1.9.0",
-    "@arcjet/ip": "1.9.0",
-    "@arcjet/logger": "1.9.0",
-    "@arcjet/protocol": "1.9.0",
-    "@arcjet/transport": "1.9.0",
-    "arcjet": "1.9.0"
+    "@arcjet/body": "1.10.0-rc.0",
+    "@arcjet/env": "1.10.0-rc.0",
+    "@arcjet/headers": "1.10.0-rc.0",
+    "@arcjet/ip": "1.10.0-rc.0",
+    "@arcjet/logger": "1.10.0-rc.0",
+    "@arcjet/protocol": "1.10.0-rc.0",
+    "@arcjet/transport": "1.10.0-rc.0",
+    "arcjet": "1.10.0-rc.0"
   },
   "devDependencies": {
     "bun-types": "1.3.14",
-    "tsdown": "0.22.3",
-    "typescript": "6.0.3",
+    "tsdown": "0.22.7",
+    "typescript": "7.0.2",
     "undici-types": "7.28.0"
   },
   "engines": {}