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

package/index.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}.
  */
@@ -47,30 +57,30 @@ export interface ArcjetNodeRequest {
     /**
      * Headers of the request.
      */
-    headers?: Record<string, string | string[] | undefined>;
+    headers?: Record<string, string | string[] | undefined> | undefined;
     /**
      * `net.Socket` object associated with the connection.
      *
      * See <https://nodejs.org/api/http.html#messagesocket>.
      */
     socket?: Partial<{
-        remoteAddress: string;
+        remoteAddress?: string | undefined;
         encrypted: boolean;
-    }>;
+    }> | undefined;
     /**
      * HTTP method of the request.
      */
-    method?: string;
+    method?: string | undefined;
     /**
      * HTTP version sent by the client.
      *
      * See <https://nodejs.org/api/http.html#messagehttpversion>.
      */
-    httpVersion?: string;
+    httpVersion?: string | undefined;
     /**
      * URL.
      */
-    url?: string;
+    url?: string | undefined;
     /**
      * Request body.
      */
@@ -82,7 +92,7 @@ export interface ArcjetNodeRequest {
      *
      * See <https://nodejs.org/api/events.html#emitteroneventname-listener>.
      */
-    on?: EventHandlerLike;
+    on?: EventHandlerLike | undefined;
     /**
      * Remove event handlers.
      *
@@ -90,7 +100,7 @@ export interface ArcjetNodeRequest {
      *
      * See <https://nodejs.org/api/events.html#emitterremovelistenereventname-listener>.
      */
-    removeListener?: EventHandlerLike;
+    removeListener?: EventHandlerLike | undefined;
     /**
      * Whether the readable stream is readable.
      *
@@ -98,7 +108,7 @@ export interface ArcjetNodeRequest {
      *
      * See <https://nodejs.org/api/stream.html#readablereadable>.
      */
-    readable?: boolean;
+    readable?: boolean | undefined;
 }
 /**
  * Configuration for the Node.js integration of Arcjet.
@@ -140,7 +150,7 @@ export interface ArcjetNode<Props extends PlainObject> {
      *   Promise that resolves to an {@linkcode ArcjetDecision} indicating
      *   Arcjet’s decision about the request.
      */
-    protect(request: ArcjetNodeRequest, ...props: Props extends WithoutCustomProps ? [] : [Props]): Promise<ArcjetDecision>;
+    protect(request: ArcjetNodeRequest, ...props: MaybeProperties<Props>): Promise<ArcjetDecision>;
     /**
      * Augment the client with another rule.
      *
@@ -154,7 +164,7 @@ export interface ArcjetNode<Props extends PlainObject> {
      * @returns
      *   Arcjet instance augmented with the given rule.
      */
-    withRule<Rule extends Primitive | Product>(rule: Rule): ArcjetNode<Simplify<Props & ExtraProps<Rule>>>;
+    withRule<ChildProperties extends PlainObject>(rule: Primitive<ChildProperties> | Product<ChildProperties>): ArcjetNode<Props & ChildProperties>;
 }
 /**
  * Create a new Node.js integration of Arcjet.
@@ -174,4 +184,4 @@ export interface ArcjetNode<Props extends PlainObject> {
  * @returns
  *   Node.js integration of Arcjet.
  */
-export default function arcjet<const Rules extends (Primitive | Product)[], const Characteristics extends readonly string[]>(options: ArcjetOptions<Rules, Characteristics>): ArcjetNode<Simplify<ExtraProps<Rules> & CharacteristicProps<Characteristics>>>;
+export default function arcjet<const Rules extends (Primitive | Product)[], const Characteristics extends readonly string[]>(options: ArcjetOptions<Rules, Characteristics>): ArcjetNode<ExtraProps<Rules> & CharacteristicProps<Characteristics>>;

package/index.js

@@ -41,6 +41,7 @@ const env = {
         return process.env.FIREBASE_CONFIG;
     },
 };
+let warnedForAutomaticBodyRead = false;
 /**
  * Create a remote client.
  *
@@ -55,7 +56,7 @@ function createRemoteClient(options) {
     // Transport is the HTTP client that the client uses to make requests.
     const transport = createTransport(url);
     const sdkStack = "NODEJS";
-    const sdkVersion = "1.0.0-beta.17";
+    const sdkVersion = "1.0.0-beta.18";
     return createClient({
         transport,
         baseUrl: url,
@@ -172,16 +173,14 @@ function arcjet(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 () => {
                     // Read the stream if the body is not present.
                     if (request.body === null || request.body === undefined) {
@@ -193,6 +192,10 @@ function arcjet(options) {
                         if (typeof expectedLengthStr === "string") {
                             expectedLength = parseInt(expectedLengthStr, 10);
                         }
+                        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 readBody(request, { expectedLength });
                     }
                     // A package like `body-parser` was used to read the stream.
@@ -203,7 +206,8 @@ function arcjet(options) {
                 };
                 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/node",
-  "version": "1.0.0-beta.17",
+  "version": "1.0.0-beta.18",
   "description": "Arcjet SDK for Node.js",
   "keywords": [
     "analyze",
@@ -50,19 +50,19 @@
     "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {
-    "@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/body": "1.0.0-beta.17",
-    "arcjet": "1.0.0-beta.17"
+    "@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/body": "1.0.0-beta.18",
+    "arcjet": "1.0.0-beta.18"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-beta.17",
-    "@arcjet/rollup-config": "1.0.0-beta.17",
-    "@types/node": "25.0.3",
+    "@arcjet/eslint-config": "1.0.0-beta.18",
+    "@arcjet/rollup-config": "1.0.0-beta.18",
+    "@types/node": "25.0.8",
     "@rollup/wasm-node": "4.55.1",
     "eslint": "9.39.2",
     "typescript": "5.9.3"