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

package/index.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="bun-types/bun.d.ts" />
-import { ArcjetDecision, ArcjetOptions, Primitive, Product, ExtraProps } from "arcjet";
+import type { ArcjetDecision, ArcjetOptions, Primitive, Product, ExtraProps, CharacteristicProps } from "arcjet";
 import type { Server } from "bun";
 export * from "arcjet";
 type Simplify<T> = {
@@ -56,4 +55,4 @@ export interface ArcjetBun<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>): ArcjetBun<Simplify<ExtraProps<Rules>>>;
+export default function arcjet<const Rules extends (Primitive | Product)[], const Characteristics extends readonly string[]>(options: ArcjetOptions<Rules, Characteristics>): ArcjetBun<Simplify<ExtraProps<Rules> & CharacteristicProps<Characteristics>>>;

package/index.js

@@ -4,7 +4,7 @@ export * from 'arcjet';
 import findIP from '@arcjet/ip';
 import ArcjetHeaders from '@arcjet/headers';
 import { env } from 'bun';
-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';
 
@@ -15,14 +15,14 @@ function createRemoteClient(options) {
     const url = options?.baseUrl ?? baseUrl(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(env) ? 500 : 1000);
+    const timeout = options?.timeout ?? (isDevelopment(env) ? 1000 : 500);
     // Transport is the HTTP client that the client uses to make requests.
     const transport = createConnectTransport({
         baseUrl: url,
         httpVersion: "1.1",
     });
     const sdkStack = "BUN";
-    const sdkVersion = "1.0.0-alpha.17";
+    const sdkVersion = "1.0.0-alpha.19";
     return createClient({
         transport,
         baseUrl: url,
@@ -31,66 +31,6 @@ function createRemoteClient(options) {
         sdkVersion,
     });
 }
-// This is provided with an `ipCache` where it attempts to lookup the IP. This
-// is primarily a workaround to the API design in Bun that requires access to
-// the `Server` to lookup an IP.
-function toArcjetRequest(ipCache, request, props) {
-    const cookies = request.headers.get("cookie") ?? undefined;
-    // We construct an ArcjetHeaders to normalize over Headers
-    const headers = new ArcjetHeaders(request.headers);
-    const url = new URL(request.url);
-    let ip = findIP({
-        ip: ipCache.get(request),
-    }, headers, { platform: platform(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(env)) {
-            // TODO: Log that the fingerprint is being overridden once the adapter
-            // constructs the logger
-            ip = "127.0.0.1";
-        }
-    }
-    return {
-        ...props,
-        ip,
-        method: request.method,
-        protocol: url.protocol,
-        host: url.host,
-        path: url.pathname,
-        headers,
-        cookies,
-        query: url.search,
-    };
-}
-function withClient(aj) {
-    // Assuming the `handler()` function was used around Bun's fetch handler
-    // this WeakMap should be populated with IP addresses inspected via
-    // `server.requestIP()`
-    const ipCache = new WeakMap();
-    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(ipCache, request, props ?? {});
-            return aj.protect({}, req);
-        },
-        handler(fetch) {
-            return async function (request, server) {
-                const socketAddress = server.requestIP(request);
-                if (socketAddress) {
-                    ipCache.set(request, socketAddress.address);
-                }
-                return fetch.call(server, request, server);
-            };
-        },
-    });
-}
 /**
  * Create a new {@link ArcjetBun} client. Always build your initial client
  * outside of a request handler so it persists across requests. If you need to
@@ -101,11 +41,73 @@ function withClient(aj) {
  */
 function arcjet(options) {
     const client = options.client ?? createRemoteClient();
+    // Assuming the `handler()` function was used around Bun's fetch handler this
+    // WeakMap should be populated with IP addresses inspected via
+    // `server.requestIP()`
+    const ipCache = new WeakMap();
     const log = options.log
         ? options.log
         : new Logger({
             level: logLevel(env),
         });
+    function toArcjetRequest(request, props) {
+        const cookies = request.headers.get("cookie") ?? undefined;
+        // We construct an ArcjetHeaders to normalize over Headers
+        const headers = new ArcjetHeaders(request.headers);
+        const url = new URL(request.url);
+        let ip = findIP({
+            // This attempts to lookup the IP in the `ipCache`. This is primarily a
+            // workaround to the API design in Bun that requires access to the
+            // `Server` to lookup an IP.
+            ip: ipCache.get(request),
+        }, headers, { platform: platform(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(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"`);
+            }
+        }
+        return {
+            ...props,
+            ip,
+            method: request.method,
+            protocol: url.protocol,
+            host: url.host,
+            path: url.pathname,
+            headers,
+            cookies,
+            query: url.search,
+        };
+    }
+    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);
+            },
+            handler(fetch) {
+                return async function (request, server) {
+                    const socketAddress = server.requestIP(request);
+                    if (socketAddress) {
+                        ipCache.set(request, socketAddress.address);
+                    }
+                    return fetch.call(server, request, server);
+                };
+            },
+        });
+    }
     const aj = core__default({ ...options, client, log });
     return withClient(aj);
 }

package/index.ts

@@ -1,6 +1,7 @@
 /// <reference types="bun-types/bun.d.ts" />
 import { createConnectTransport } from "@connectrpc/connect-node";
-import core, {
+import core from "arcjet";
+import type {
   ArcjetDecision,
   ArcjetOptions,
   Primitive,
@@ -8,18 +9,13 @@ import core, {
   ArcjetRequest,
   ExtraProps,
   Arcjet,
+  CharacteristicProps,
 } from "arcjet";
 import findIP from "@arcjet/ip";
 import ArcjetHeaders from "@arcjet/headers";
 import type { Server } from "bun";
 import { env } from "bun";
-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";
 
@@ -75,7 +71,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(env) ? 500 : 1000);
+  const timeout = options?.timeout ?? (isDevelopment(env) ? 1000 : 500);
 
   // Transport is the HTTP client that the client uses to make requests.
   const transport = createConnectTransport({
@@ -146,102 +142,6 @@ export interface ArcjetBun<Props extends PlainObject> {
   ) => Response | Promise<Response>;
 }
 
-// This is provided with an `ipCache` where it attempts to lookup the IP. This
-// is primarily a workaround to the API design in Bun that requires access to
-// the `Server` to lookup an IP.
-function toArcjetRequest<Props extends PlainObject>(
-  ipCache: WeakMap<Request, string>,
-  request: Request,
-  props: Props,
-): ArcjetRequest<Props> {
-  const cookies = request.headers.get("cookie") ?? undefined;
-
-  // We construct an ArcjetHeaders to normalize over Headers
-  const headers = new ArcjetHeaders(request.headers);
-
-  const url = new URL(request.url);
-  let ip = findIP(
-    {
-      ip: ipCache.get(request),
-    },
-    headers,
-    { platform: platform(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(env)) {
-      // TODO: Log that the fingerprint is being overridden once the adapter
-      // constructs the logger
-      ip = "127.0.0.1";
-    }
-  }
-
-  return {
-    ...props,
-    ip,
-    method: request.method,
-    protocol: url.protocol,
-    host: url.host,
-    path: url.pathname,
-    headers,
-    cookies,
-    query: url.search,
-  };
-}
-
-function withClient<const Rules extends (Primitive | Product)[]>(
-  aj: Arcjet<ExtraProps<Rules>>,
-): ArcjetBun<ExtraProps<Rules>> {
-  // Assuming the `handler()` function was used around Bun's fetch handler
-  // this WeakMap should be populated with IP addresses inspected via
-  // `server.requestIP()`
-  const ipCache = new WeakMap<Request, string>();
-
-  return Object.freeze({
-    withRule(rule: Primitive | Product) {
-      const client = aj.withRule(rule);
-      return withClient(client);
-    },
-    async protect(
-      request: Request,
-      ...[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(
-        ipCache,
-        request,
-        props ?? {},
-      ) as ArcjetRequest<ExtraProps<Rules>>;
-
-      return aj.protect({}, req);
-    },
-    handler(
-      fetch: (
-        this: Server,
-        request: Request,
-        server: Server,
-      ) => Response | Promise<Response>,
-    ) {
-      return async function (
-        request: Request,
-        server: Server,
-      ): Promise<Response> {
-        const socketAddress = server.requestIP(request);
-        if (socketAddress) {
-          ipCache.set(request, socketAddress.address);
-        }
-
-        return fetch.call(server, request, server);
-      };
-    },
-  });
-}
-
 /**
  * Create a new {@link ArcjetBun} client. Always build your initial client
  * outside of a request handler so it persists across requests. If you need to
@@ -250,17 +150,118 @@ 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>,
-): ArcjetBun<Simplify<ExtraProps<Rules>>> {
+export default function arcjet<
+  const Rules extends (Primitive | Product)[],
+  const Characteristics extends readonly string[],
+>(
+  options: ArcjetOptions<Rules, Characteristics>,
+): ArcjetBun<
+  Simplify<ExtraProps<Rules> & CharacteristicProps<Characteristics>>
+> {
   const client = options.client ?? createRemoteClient();
 
+  // Assuming the `handler()` function was used around Bun's fetch handler this
+  // WeakMap should be populated with IP addresses inspected via
+  // `server.requestIP()`
+  const ipCache = new WeakMap<Request, string>();
+
   const log = options.log
     ? options.log
     : new Logger({
         level: logLevel(env),
       });
 
+  function toArcjetRequest<Props extends PlainObject>(
+    request: Request,
+    props: Props,
+  ): ArcjetRequest<Props> {
+    const cookies = request.headers.get("cookie") ?? undefined;
+
+    // We construct an ArcjetHeaders to normalize over Headers
+    const headers = new ArcjetHeaders(request.headers);
+
+    const url = new URL(request.url);
+    let ip = findIP(
+      {
+        // This attempts to lookup the IP in the `ipCache`. This is primarily a
+        // workaround to the API design in Bun that requires access to the
+        // `Server` to lookup an IP.
+        ip: ipCache.get(request),
+      },
+      headers,
+      { platform: platform(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(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"`,
+        );
+      }
+    }
+
+    return {
+      ...props,
+      ip,
+      method: request.method,
+      protocol: url.protocol,
+      host: url.host,
+      path: url.pathname,
+      headers,
+      cookies,
+      query: url.search,
+    };
+  }
+
+  function withClient<const Rules extends (Primitive | Product)[]>(
+    aj: Arcjet<ExtraProps<Rules>>,
+  ): ArcjetBun<ExtraProps<Rules>> {
+    return Object.freeze({
+      withRule(rule: Primitive | Product) {
+        const client = aj.withRule(rule);
+        return withClient(client);
+      },
+      async protect(
+        request: Request,
+        ...[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);
+      },
+      handler(
+        fetch: (
+          this: Server,
+          request: Request,
+          server: Server,
+        ) => Response | Promise<Response>,
+      ) {
+        return async function (
+          request: Request,
+          server: Server,
+        ): Promise<Response> {
+          const socketAddress = server.requestIP(request);
+          if (socketAddress) {
+            ipCache.set(request, socketAddress.address);
+          }
+
+          return fetch.call(server, request, server);
+        };
+      },
+    });
+  }
+
   const aj = core({ ...options, client, log });
 
   return withClient(aj);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/bun",
-  "version": "1.0.0-alpha.17",
+  "version": "1.0.0-alpha.19",
   "description": "Arcjet SDK for Bun.sh",
   "license": "Apache-2.0",
   "homepage": "https://arcjet.com",
@@ -38,24 +38,24 @@
     "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": "20.12.12",
-    "@rollup/wasm-node": "4.18.0",
-    "bun-types": "1.1.13",
+    "@rollup/wasm-node": "4.18.1",
+    "bun-types": "1.1.20",
     "jest": "29.7.0",
-    "typescript": "5.4.5"
+    "typescript": "5.5.3"
   },
   "publishConfig": {
     "access": "public",