@arcjet/astro 1.0.0-beta.17 → 1.0.0-beta.18

package/internal.d.ts

@@ -4,12 +4,22 @@ type Simplify<T> = {
     [KeyType in keyof T]: T[KeyType];
 } & {};
 declare const emptyObjectSymbol: unique symbol;
-type WithoutCustomProps = {
-    [emptyObjectSymbol]?: never;
-};
 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
+];
 /**
  * Configuration for {@linkcode createRemoteClient}.
  */
@@ -77,7 +87,7 @@ export interface ArcjetAstro<Props extends PlainObject> {
      *   Promise that resolves to an {@linkcode ArcjetDecision} indicating
      *   Arcjet’s decision about the request.
      */
-    protect(request: Request, ...props: Props extends WithoutCustomProps ? [] : [Props]): Promise<ArcjetDecision>;
+    protect(request: Request, ...props: MaybeProperties<Props>): Promise<ArcjetDecision>;
     /**
      * Augment the client with another rule.
      *
@@ -91,7 +101,7 @@ export interface ArcjetAstro<Props extends PlainObject> {
      * @returns
      *   Arcjet instance augmented with the given rule.
      */
-    withRule<Rule extends Primitive | Product>(rule: Rule): ArcjetAstro<Simplify<Props & ExtraProps<Rule>>>;
+    withRule<ChildProperties extends PlainObject>(rule: Primitive<ChildProperties> | Product<ChildProperties>): ArcjetAstro<Props & ChildProperties>;
 }
 /**
  * Create a new Astro integration of Arcjet.
@@ -105,4 +115,4 @@ export interface ArcjetAstro<Props extends PlainObject> {
  * @returns
  *   Astro integration of Arcjet.
  */
-export declare function createArcjetClient<const Rules extends (Primitive | Product)[], const Characteristics extends readonly string[]>(options: ArcjetOptions<Rules, Characteristics>): ArcjetAstro<Simplify<ExtraProps<Rules> & CharacteristicProps<Characteristics>>>;
+export declare function createArcjetClient<const Rules extends (Primitive | Product)[], const Characteristics extends readonly string[]>(options: ArcjetOptions<Rules, Characteristics>): ArcjetAstro<ExtraProps<Rules> & CharacteristicProps<Characteristics>>;

package/internal.js

@@ -9,6 +9,7 @@ import { createClient } from '@arcjet/protocol/client.js';
 import { createTransport } from '@arcjet/transport';
 import { VERCEL, RENDER, FLY_APP_NAME, FIREBASE_CONFIG, ARCJET_LOG_LEVEL, ARCJET_KEY, ARCJET_ENV, ARCJET_BASE_URL } from 'astro:env/server';
 
+let warnedForAutomaticBodyRead = false;
 // We use a middleware to store the IP address on a `Request` with this symbol.
 // This is due to Astro inconsistently using `Symbol.for("astro.clientAddress")`
 // to store the client address and not exporting it from their module.
@@ -39,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.0.0-beta.17";
+    const sdkVersion = "1.0.0-beta.18";
     return createClient({
         transport,
         baseUrl: url,
@@ -78,7 +79,7 @@ function createArcjetClient(options) {
         if (!clientAddress) {
             throw new Error("`protect()` cannot be used in prerendered pages");
         }
-        const cookies = request.headers.get("cookie") ?? undefined;
+        const cookies = request.headers.get("cookie") ?? "";
         // We construct an ArcjetHeaders to normalize over Headers
         const headers = new ArcjetHeaders(request.headers);
         const url = new URL(request.url);
@@ -110,16 +111,14 @@ function createArcjetClient(options) {
         };
     }
     function withClient(aj) {
-        return Object.freeze({
+        const client = {
             withRule(rule) {
                 const client = aj.withRule(rule);
                 return withClient(client);
             },
-            async protect(request, ...[props]) {
-                // TODO(#220): The generic manipulations get really mad here, so we cast
-                // Further investigation makes it seem like it has something to do with
-                // the definition of `props` in the signature but it's hard to track down
-                const req = toArcjetRequest(request, props ?? {});
+            async protect(request, props) {
+                // Cast of `{}` because here we switch from `undefined` to `Properties`.
+                const req = toArcjetRequest(request, props || {});
                 const getBody = async () => {
                     const clonedRequest = request.clone();
                     let expectedLength;
@@ -131,11 +130,16 @@ function createArcjetClient(options) {
                     if (!clonedRequest.body) {
                         throw new Error("Cannot read body: body is missing");
                     }
+                    if (!warnedForAutomaticBodyRead) {
+                        warnedForAutomaticBodyRead = true;
+                        log.warn("Automatically reading the request body is deprecated; please pass an explicit `sensitiveInfoValue` field. See <https://docs.arcjet.com/upgrading/sdk-migration>.");
+                    }
                     return readBodyWeb(clonedRequest.body, { expectedLength });
                 };
                 return aj.protect({ getBody }, req);
             },
-        });
+        };
+        return Object.freeze(client);
     }
     const aj = core__default({ ...options, client, log });
     return withClient(aj);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/astro",
-  "version": "1.0.0-beta.17",
+  "version": "1.0.0-beta.18",
   "description": "Arcjet helps developers protect their Astro sites in just a few lines of code. Bot detection. Rate limiting. Email validation. Attack protection. Data redaction. A developer-first approach to security.",
   "keywords": [
     "analyze",
@@ -52,23 +52,23 @@
     "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {
-    "@arcjet/body": "1.0.0-beta.17",
-    "@arcjet/env": "1.0.0-beta.17",
-    "@arcjet/headers": "1.0.0-beta.17",
-    "@arcjet/ip": "1.0.0-beta.17",
-    "@arcjet/logger": "1.0.0-beta.17",
-    "@arcjet/protocol": "1.0.0-beta.17",
-    "@arcjet/transport": "1.0.0-beta.17",
-    "arcjet": "1.0.0-beta.17"
+    "@arcjet/body": "1.0.0-beta.18",
+    "@arcjet/env": "1.0.0-beta.18",
+    "@arcjet/headers": "1.0.0-beta.18",
+    "@arcjet/ip": "1.0.0-beta.18",
+    "@arcjet/logger": "1.0.0-beta.18",
+    "@arcjet/protocol": "1.0.0-beta.18",
+    "@arcjet/transport": "1.0.0-beta.18",
+    "arcjet": "1.0.0-beta.18"
   },
   "peerDependencies": {
     "astro": "^5.9.3"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-beta.17",
-    "@arcjet/rollup-config": "1.0.0-beta.17",
+    "@arcjet/eslint-config": "1.0.0-beta.18",
+    "@arcjet/rollup-config": "1.0.0-beta.18",
     "@rollup/wasm-node": "4.55.1",
-    "astro": "5.16.6",
+    "astro": "5.16.9",
     "eslint": "9.39.2",
     "typescript": "5.9.3"
   },