@arcjet/node 1.0.0-alpha.17 → 1.0.0-alpha.19

package/index.d.ts

@@ -1,4 +1,4 @@
-import { ArcjetDecision, ArcjetOptions, Primitive, Product, ExtraProps } from "arcjet";
+import type { ArcjetDecision, ArcjetOptions, Primitive, Product, ExtraProps, CharacteristicProps } from "arcjet";
 export * from "arcjet";
 type Simplify<T> = {
     [KeyType in keyof T]: T[KeyType];
@@ -57,4 +57,4 @@ export interface ArcjetNode<Props extends PlainObject> {
  *
  * @param options - Arcjet configuration options to apply to all requests.
  */
-export default function arcjet<const Rules extends (Primitive | Product)[]>(options: ArcjetOptions<Rules>): ArcjetNode<Simplify<ExtraProps<Rules>>>;
+export default function arcjet<const Rules extends (Primitive | Product)[], const Characteristics extends readonly string[]>(options: ArcjetOptions<Rules, Characteristics>): ArcjetNode<Simplify<ExtraProps<Rules> & CharacteristicProps<Characteristics>>>;

package/index.js

@@ -3,7 +3,7 @@ import core__default from 'arcjet';
 export * from 'arcjet';
 import findIP from '@arcjet/ip';
 import ArcjetHeaders from '@arcjet/headers';
-import { logLevel, baseUrl, isProduction, platform, isDevelopment } from '@arcjet/env';
+import { logLevel, baseUrl, isDevelopment, platform } from '@arcjet/env';
 import { Logger } from '@arcjet/logger';
 import { createClient } from '@arcjet/protocol/client.js';
 
@@ -13,14 +13,14 @@ function createRemoteClient(options) {
     const url = options?.baseUrl ?? baseUrl(process.env);
     // The timeout for the Arcjet API in milliseconds. This is set to a low value
     // in production so calls fail open.
-    const timeout = options?.timeout ?? (isProduction(process.env) ? 500 : 1000);
+    const timeout = options?.timeout ?? (isDevelopment(process.env) ? 1000 : 500);
     // Transport is the HTTP client that the client uses to make requests.
     const transport = createConnectTransport({
         baseUrl: url,
         httpVersion: "2",
     });
     const sdkStack = "NODEJS";
-    const sdkVersion = "1.0.0-alpha.17";
+    const sdkVersion = "1.0.0-alpha.19";
     return createClient({
         transport,
         baseUrl: url,
@@ -39,77 +39,6 @@ function cookiesToString(cookies) {
     }
     return cookies;
 }
-function toArcjetRequest(request, props) {
-    // We pull the cookies from the request before wrapping them in ArcjetHeaders
-    const cookies = cookiesToString(request.headers?.cookie);
-    // We construct an ArcjetHeaders to normalize over Headers
-    const headers = new ArcjetHeaders(request.headers);
-    let ip = findIP(request, headers, { platform: platform(process.env) });
-    if (ip === "") {
-        // If the `ip` is empty but we're in development mode, we default the IP
-        // so the request doesn't fail.
-        if (isDevelopment(process.env)) {
-            // TODO: Log that the fingerprint is being overridden once the adapter
-            // constructs the logger
-            ip = "127.0.0.1";
-        }
-    }
-    const method = request.method ?? "";
-    const host = headers.get("host") ?? "";
-    let path = "";
-    let query = "";
-    let protocol = "";
-    if (typeof request.socket?.encrypted !== "undefined") {
-        protocol = request.socket.encrypted ? "https:" : "http:";
-    }
-    else {
-        protocol = "http:";
-    }
-    // Do some very simple validation, but also try/catch around URL parsing
-    if (typeof request.url !== "undefined" && request.url !== "" && host !== "") {
-        try {
-            const url = new URL(request.url, `${protocol}//${host}`);
-            path = url.pathname;
-            query = url.search;
-            protocol = url.protocol;
-        }
-        catch {
-            // If the parsing above fails, just set the path as whatever url we
-            // received.
-            // TODO(#216): Add logging to arcjet-node
-            path = request.url ?? "";
-        }
-    }
-    else {
-        path = request.url ?? "";
-    }
-    return {
-        ...props,
-        ip,
-        method,
-        protocol,
-        host,
-        path,
-        headers,
-        cookies,
-        query,
-    };
-}
-function withClient(aj) {
-    return Object.freeze({
-        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 ?? {});
-            return aj.protect({}, req);
-        },
-    });
-}
 /**
  * Create a new {@link ArcjetNode} client. Always build your initial client
  * outside of a request handler so it persists across requests. If you need to
@@ -125,6 +54,81 @@ function arcjet(options) {
         : new Logger({
             level: logLevel(process.env),
         });
+    function toArcjetRequest(request, props) {
+        // We pull the cookies from the request before wrapping them in ArcjetHeaders
+        const cookies = cookiesToString(request.headers?.cookie);
+        // We construct an ArcjetHeaders to normalize over Headers
+        const headers = new ArcjetHeaders(request.headers);
+        let ip = findIP(request, headers, { platform: platform(process.env) });
+        if (ip === "") {
+            // If the `ip` is empty but we're in development mode, we default the IP
+            // so the request doesn't fail.
+            if (isDevelopment(process.env)) {
+                log.warn("Using 127.0.0.1 as IP address in development mode");
+                ip = "127.0.0.1";
+            }
+            else {
+                log.warn(`Client IP address is missing. If this is a dev environment set the ARCJET_ENV env var to "development"`);
+            }
+        }
+        const method = request.method ?? "";
+        const host = headers.get("host") ?? "";
+        let path = "";
+        let query = "";
+        let protocol = "";
+        if (typeof request.socket?.encrypted !== "undefined") {
+            protocol = request.socket.encrypted ? "https:" : "http:";
+        }
+        else {
+            protocol = "http:";
+        }
+        // Do some very simple validation, but also try/catch around URL parsing
+        if (typeof request.url !== "undefined" &&
+            request.url !== "" &&
+            host !== "") {
+            try {
+                const url = new URL(request.url, `${protocol}//${host}`);
+                path = url.pathname;
+                query = url.search;
+                protocol = url.protocol;
+            }
+            catch {
+                // If the parsing above fails, just set the path as whatever url we
+                // received.
+                path = request.url ?? "";
+                log.warn('Unable to parse URL. Using "%s" as `path`.', path);
+            }
+        }
+        else {
+            path = request.url ?? "";
+        }
+        return {
+            ...props,
+            ip,
+            method,
+            protocol,
+            host,
+            path,
+            headers,
+            cookies,
+            query,
+        };
+    }
+    function withClient(aj) {
+        return Object.freeze({
+            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 ?? {});
+                return aj.protect({}, req);
+            },
+        });
+    }
     const aj = core__default({ ...options, client, log });
     return withClient(aj);
 }

package/index.ts

@@ -1,5 +1,6 @@
 import { createConnectTransport } from "@connectrpc/connect-node";
-import core, {
+import core from "arcjet";
+import type {
   ArcjetDecision,
   ArcjetOptions,
   Primitive,
@@ -7,16 +8,11 @@ import core, {
   ArcjetRequest,
   ExtraProps,
   Arcjet,
+  CharacteristicProps,
 } from "arcjet";
 import findIP from "@arcjet/ip";
 import ArcjetHeaders from "@arcjet/headers";
-import {
-  baseUrl,
-  isDevelopment,
-  isProduction,
-  logLevel,
-  platform,
-} from "@arcjet/env";
+import { baseUrl, isDevelopment, logLevel, platform } from "@arcjet/env";
 import { Logger } from "@arcjet/logger";
 import { createClient } from "@arcjet/protocol/client.js";
 
@@ -72,7 +68,7 @@ export function createRemoteClient(options?: RemoteClientOptions) {
 
   // The timeout for the Arcjet API in milliseconds. This is set to a low value
   // in production so calls fail open.
-  const timeout = options?.timeout ?? (isProduction(process.env) ? 500 : 1000);
+  const timeout = options?.timeout ?? (isDevelopment(process.env) ? 1000 : 500);
 
   // Transport is the HTTP client that the client uses to make requests.
   const transport = createConnectTransport({
@@ -148,94 +144,6 @@ export interface ArcjetNode<Props extends PlainObject> {
   ): ArcjetNode<Simplify<Props & ExtraProps<Rule>>>;
 }
 
-function toArcjetRequest<Props extends PlainObject>(
-  request: ArcjetNodeRequest,
-  props: Props,
-): ArcjetRequest<Props> {
-  // We pull the cookies from the request before wrapping them in ArcjetHeaders
-  const cookies = cookiesToString(request.headers?.cookie);
-
-  // We construct an ArcjetHeaders to normalize over Headers
-  const headers = new ArcjetHeaders(request.headers);
-
-  let ip = findIP(request, headers, { platform: platform(process.env) });
-  if (ip === "") {
-    // If the `ip` is empty but we're in development mode, we default the IP
-    // so the request doesn't fail.
-    if (isDevelopment(process.env)) {
-      // TODO: Log that the fingerprint is being overridden once the adapter
-      // constructs the logger
-      ip = "127.0.0.1";
-    }
-  }
-  const method = request.method ?? "";
-  const host = headers.get("host") ?? "";
-  let path = "";
-  let query = "";
-  let protocol = "";
-
-  if (typeof request.socket?.encrypted !== "undefined") {
-    protocol = request.socket.encrypted ? "https:" : "http:";
-  } else {
-    protocol = "http:";
-  }
-
-  // Do some very simple validation, but also try/catch around URL parsing
-  if (typeof request.url !== "undefined" && request.url !== "" && host !== "") {
-    try {
-      const url = new URL(request.url, `${protocol}//${host}`);
-      path = url.pathname;
-      query = url.search;
-      protocol = url.protocol;
-    } catch {
-      // If the parsing above fails, just set the path as whatever url we
-      // received.
-      // TODO(#216): Add logging to arcjet-node
-      path = request.url ?? "";
-    }
-  } else {
-    path = request.url ?? "";
-  }
-
-  return {
-    ...props,
-    ip,
-    method,
-    protocol,
-    host,
-    path,
-    headers,
-    cookies,
-    query,
-  };
-}
-
-function withClient<const Rules extends (Primitive | Product)[]>(
-  aj: Arcjet<ExtraProps<Rules>>,
-): ArcjetNode<ExtraProps<Rules>> {
-  return Object.freeze({
-    withRule(rule: Primitive | Product) {
-      const client = aj.withRule(rule);
-      return withClient(client);
-    },
-    async protect(
-      request: ArcjetNodeRequest,
-      ...[props]: ExtraProps<Rules> extends WithoutCustomProps
-        ? []
-        : [ExtraProps<Rules>]
-    ): Promise<ArcjetDecision> {
-      // 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 ?? {}) as ArcjetRequest<
-        ExtraProps<Rules>
-      >;
-
-      return aj.protect({}, req);
-    },
-  });
-}
-
 /**
  * Create a new {@link ArcjetNode} client. Always build your initial client
  * outside of a request handler so it persists across requests. If you need to
@@ -244,9 +152,14 @@ function withClient<const Rules extends (Primitive | Product)[]>(
  *
  * @param options - Arcjet configuration options to apply to all requests.
  */
-export default function arcjet<const Rules extends (Primitive | Product)[]>(
-  options: ArcjetOptions<Rules>,
-): ArcjetNode<Simplify<ExtraProps<Rules>>> {
+export default function arcjet<
+  const Rules extends (Primitive | Product)[],
+  const Characteristics extends readonly string[],
+>(
+  options: ArcjetOptions<Rules, Characteristics>,
+): ArcjetNode<
+  Simplify<ExtraProps<Rules> & CharacteristicProps<Characteristics>>
+> {
   const client = options.client ?? createRemoteClient();
 
   const log = options.log
@@ -255,6 +168,101 @@ export default function arcjet<const Rules extends (Primitive | Product)[]>(
         level: logLevel(process.env),
       });
 
+  function toArcjetRequest<Props extends PlainObject>(
+    request: ArcjetNodeRequest,
+    props: Props,
+  ): ArcjetRequest<Props> {
+    // We pull the cookies from the request before wrapping them in ArcjetHeaders
+    const cookies = cookiesToString(request.headers?.cookie);
+
+    // We construct an ArcjetHeaders to normalize over Headers
+    const headers = new ArcjetHeaders(request.headers);
+
+    let ip = findIP(request, headers, { platform: platform(process.env) });
+    if (ip === "") {
+      // If the `ip` is empty but we're in development mode, we default the IP
+      // so the request doesn't fail.
+      if (isDevelopment(process.env)) {
+        log.warn("Using 127.0.0.1 as IP address in development mode");
+        ip = "127.0.0.1";
+      } else {
+        log.warn(
+          `Client IP address is missing. If this is a dev environment set the ARCJET_ENV env var to "development"`,
+        );
+      }
+    }
+    const method = request.method ?? "";
+    const host = headers.get("host") ?? "";
+    let path = "";
+    let query = "";
+    let protocol = "";
+
+    if (typeof request.socket?.encrypted !== "undefined") {
+      protocol = request.socket.encrypted ? "https:" : "http:";
+    } else {
+      protocol = "http:";
+    }
+
+    // Do some very simple validation, but also try/catch around URL parsing
+    if (
+      typeof request.url !== "undefined" &&
+      request.url !== "" &&
+      host !== ""
+    ) {
+      try {
+        const url = new URL(request.url, `${protocol}//${host}`);
+        path = url.pathname;
+        query = url.search;
+        protocol = url.protocol;
+      } catch {
+        // If the parsing above fails, just set the path as whatever url we
+        // received.
+        path = request.url ?? "";
+        log.warn('Unable to parse URL. Using "%s" as `path`.', path);
+      }
+    } else {
+      path = request.url ?? "";
+    }
+
+    return {
+      ...props,
+      ip,
+      method,
+      protocol,
+      host,
+      path,
+      headers,
+      cookies,
+      query,
+    };
+  }
+
+  function withClient<const Rules extends (Primitive | Product)[]>(
+    aj: Arcjet<ExtraProps<Rules>>,
+  ): ArcjetNode<ExtraProps<Rules>> {
+    return Object.freeze({
+      withRule(rule: Primitive | Product) {
+        const client = aj.withRule(rule);
+        return withClient(client);
+      },
+      async protect(
+        request: ArcjetNodeRequest,
+        ...[props]: ExtraProps<Rules> extends WithoutCustomProps
+          ? []
+          : [ExtraProps<Rules>]
+      ): Promise<ArcjetDecision> {
+        // 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 ?? {}) as ArcjetRequest<
+          ExtraProps<Rules>
+        >;
+
+        return aj.protect({}, req);
+      },
+    });
+  }
+
   const aj = core({ ...options, client, log });
 
   return withClient(aj);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/node",
-  "version": "1.0.0-alpha.17",
+  "version": "1.0.0-alpha.19",
   "description": "Arcjet SDK for Node.js",
   "license": "Apache-2.0",
   "homepage": "https://arcjet.com",
@@ -40,23 +40,23 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
   },
   "dependencies": {
-    "@arcjet/env": "1.0.0-alpha.17",
-    "@arcjet/headers": "1.0.0-alpha.17",
-    "@arcjet/ip": "1.0.0-alpha.17",
-    "@arcjet/logger": "1.0.0-alpha.17",
-    "@arcjet/protocol": "1.0.0-alpha.17",
+    "@arcjet/env": "1.0.0-alpha.19",
+    "@arcjet/headers": "1.0.0-alpha.19",
+    "@arcjet/ip": "1.0.0-alpha.19",
+    "@arcjet/logger": "1.0.0-alpha.19",
+    "@arcjet/protocol": "1.0.0-alpha.19",
     "@connectrpc/connect-node": "1.4.0",
-    "arcjet": "1.0.0-alpha.17"
+    "arcjet": "1.0.0-alpha.19"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-alpha.17",
-    "@arcjet/rollup-config": "1.0.0-alpha.17",
-    "@arcjet/tsconfig": "1.0.0-alpha.17",
+    "@arcjet/eslint-config": "1.0.0-alpha.19",
+    "@arcjet/rollup-config": "1.0.0-alpha.19",
+    "@arcjet/tsconfig": "1.0.0-alpha.19",
     "@jest/globals": "29.7.0",
     "@types/node": "18.18.0",
-    "@rollup/wasm-node": "4.18.0",
+    "@rollup/wasm-node": "4.18.1",
     "jest": "29.7.0",
-    "typescript": "5.4.5"
+    "typescript": "5.5.3"
   },
   "publishConfig": {
     "access": "public",