@arcjet/bun 1.0.0-alpha.31 → 1.0.0-alpha.32

package/index.js

@@ -33,7 +33,7 @@ function createRemoteClient(options) {
     // Transport is the HTTP client that the client uses to make requests.
     const transport = createTransport(url);
     const sdkStack = "BUN";
-    const sdkVersion = "1.0.0-alpha.31";
+    const sdkVersion = "1.0.0-alpha.32";
     return createClient({
         transport,
         baseUrl: url,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/bun",
-  "version": "1.0.0-alpha.31",
+  "version": "1.0.0-alpha.32",
   "description": "Arcjet SDK for Bun.sh",
   "license": "Apache-2.0",
   "homepage": "https://arcjet.com",
@@ -27,7 +27,6 @@
     "README.md",
     "*.js",
     "*.d.ts",
-    "*.ts",
     "!*.config.js"
   ],
   "scripts": {
@@ -38,24 +37,24 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
   },
   "dependencies": {
-    "@arcjet/env": "1.0.0-alpha.31",
-    "@arcjet/headers": "1.0.0-alpha.31",
-    "@arcjet/ip": "1.0.0-alpha.31",
-    "@arcjet/logger": "1.0.0-alpha.31",
-    "@arcjet/protocol": "1.0.0-alpha.31",
-    "@arcjet/transport": "1.0.0-alpha.31",
-    "arcjet": "1.0.0-alpha.31"
+    "@arcjet/env": "1.0.0-alpha.32",
+    "@arcjet/headers": "1.0.0-alpha.32",
+    "@arcjet/ip": "1.0.0-alpha.32",
+    "@arcjet/logger": "1.0.0-alpha.32",
+    "@arcjet/protocol": "1.0.0-alpha.32",
+    "@arcjet/transport": "1.0.0-alpha.32",
+    "arcjet": "1.0.0-alpha.32"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-alpha.31",
-    "@arcjet/rollup-config": "1.0.0-alpha.31",
-    "@arcjet/tsconfig": "1.0.0-alpha.31",
+    "@arcjet/eslint-config": "1.0.0-alpha.32",
+    "@arcjet/rollup-config": "1.0.0-alpha.32",
+    "@arcjet/tsconfig": "1.0.0-alpha.32",
     "@jest/globals": "29.7.0",
     "@types/node": "20.12.12",
-    "@rollup/wasm-node": "4.27.3",
-    "bun-types": "1.1.36",
+    "@rollup/wasm-node": "4.27.4",
+    "bun-types": "1.1.37",
     "jest": "29.7.0",
-    "typescript": "5.6.3"
+    "typescript": "5.7.2"
   },
   "publishConfig": {
     "access": "public",

package/index.ts

@@ -1,296 +0,0 @@
-/// <reference types="bun-types/bun.d.ts" />
-import core from "arcjet";
-import type {
-  ArcjetDecision,
-  ArcjetOptions,
-  Primitive,
-  Product,
-  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, logLevel, platform } from "@arcjet/env";
-import { Logger } from "@arcjet/logger";
-import { createClient } from "@arcjet/protocol/client.js";
-import { createTransport } from "@arcjet/transport";
-
-// Re-export all named exports from the generic SDK
-export * from "arcjet";
-
-// TODO: Deduplicate with other packages
-function errorMessage(err: unknown): string {
-  if (err) {
-    if (typeof err === "string") {
-      return err;
-    }
-
-    if (
-      typeof err === "object" &&
-      "message" in err &&
-      typeof err.message === "string"
-    ) {
-      return err.message;
-    }
-  }
-
-  return "Unknown problem";
-}
-
-// Type helpers from https://github.com/sindresorhus/type-fest but adjusted for
-// our use.
-//
-// Simplify:
-// https://github.com/sindresorhus/type-fest/blob/964466c9d59c711da57a5297ad954c13132a0001/source/simplify.d.ts
-// EmptyObject:
-// https://github.com/sindresorhus/type-fest/blob/b9723d4785f01f8d2487c09ee5871a1f615781aa/source/empty-object.d.ts
-//
-// Licensed: MIT License Copyright (c) Sindre Sorhus <sindresorhus@gmail.com>
-// (https://sindresorhus.com)
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions: The above copyright
-// notice and this permission notice shall be included in all copies or
-// substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-// SOFTWARE.
-type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
-declare const emptyObjectSymbol: unique symbol;
-type WithoutCustomProps = {
-  [emptyObjectSymbol]?: never;
-};
-
-type PlainObject = {
-  [key: string]: unknown;
-};
-
-export type RemoteClientOptions = {
-  baseUrl?: string;
-  timeout?: number;
-};
-
-export function createRemoteClient(options?: RemoteClientOptions) {
-  // The base URL for the Arcjet API. Will default to the standard production
-  // API unless environment variable `ARCJET_BASE_URL` is set.
-  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 ?? (isDevelopment(env) ? 1000 : 500);
-
-  // Transport is the HTTP client that the client uses to make requests.
-  const transport = createTransport(url);
-
-  const sdkStack = "BUN";
-  const sdkVersion = "__ARCJET_SDK_VERSION__";
-
-  return createClient({
-    transport,
-    baseUrl: url,
-    timeout,
-    sdkStack,
-    sdkVersion,
-  });
-}
-
-/**
- * The ArcjetBun client provides a public `protect()` method to
- * make a decision about how a Bun.sh request should be handled.
- */
-export interface ArcjetBun<Props extends PlainObject> {
-  /**
-   * Runs a request through the configured protections. The request is
-   * analyzed and then a decision made on whether to allow, deny, or challenge
-   * the request.
-   *
-   * @param request - A `Request` provided to the fetch handler.
-   * @param props - Additonal properties required for running rules against a request.
-   * @returns An {@link ArcjetDecision} indicating Arcjet's decision about the request.
-   */
-  protect(
-    request: Request,
-    // We use this neat trick from https://stackoverflow.com/a/52318137 to make a single spread parameter
-    // that is required if the ExtraProps aren't strictly an empty object
-    ...props: Props extends WithoutCustomProps ? [] : [Props]
-  ): Promise<ArcjetDecision>;
-
-  /**
-   * Augments the client with another rule. Useful for varying rules based on
-   * criteria in your handler—e.g. different rate limit for logged in users.
-   *
-   * @param rule The rule to add to this execution.
-   * @returns An augmented {@link ArcjetBun} client.
-   */
-  withRule<Rule extends Primitive | Product>(
-    rule: Rule,
-  ): ArcjetBun<Simplify<Props & ExtraProps<Rule>>>;
-
-  /**
-   * Wraps the Bun.sh `fetch` handler to provide additional Request details
-   * when calling the SDK's `protect()` function.
-   *
-   * @param fetch: The user provided `fetch` handler
-   */
-  handler(
-    fetch: (
-      this: Server,
-      request: Request,
-      server: Server,
-    ) => Response | Promise<Response>,
-  ): (
-    this: Server,
-    request: Request,
-    server: Server,
-  ) => Response | Promise<Response>;
-}
-
-/**
- * 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
- * augment a client inside a handler, call the `withRule()` function on the base
- * client.
- *
- * @param options - Arcjet configuration options to apply to all requests.
- */
-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>
-        >;
-
-        const getBody = async () => {
-          try {
-            const clonedRequest = request.clone();
-            // Awaited to throw if it rejects and we'll just return undefined
-            const body = await clonedRequest.text();
-            return body;
-          } catch (e) {
-            log.error("failed to get request body: %s", errorMessage(e));
-            return;
-          }
-        };
-
-        return aj.protect({ getBody }, 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);
-}