@arcjet/astro 1.6.1 → 1.7.0-rc.0

package/internal.d.ts

@@ -1,123 +0,0 @@
-import type { ArcjetDecision, ArcjetOptions as CoreOptions, ArcjetRule, Primitive, Product, ExtraProps, CharacteristicProps } from "arcjet";
-import { type ProxyService } from "@arcjet/ip";
-export * from "arcjet";
-type Simplify<T> = {
-    [KeyType in keyof T]: T[KeyType];
-} & {};
-declare const emptyObjectSymbol: unique symbol;
-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}.
- */
-export type RemoteClientOptions = {
-    /**
-     * Base URI for HTTP requests to Decide API (optional).
-     *
-     * Defaults to the environment variable `ARCJET_BASE_URL` (if that value
-     * is known and allowed) and the standard production API otherwise.
-     */
-    baseUrl?: string;
-    /**
-     * Timeout in milliseconds for the Decide API (optional).
-     *
-     * Defaults to `500` in production and `1000` in development.
-     */
-    timeout?: number;
-};
-/**
- * Create a remote client.
- *
- * @param options
- *   Configuration (optional).
- * @returns
- *   Client.
- */
-export declare function createRemoteClient(options?: RemoteClientOptions): import("@arcjet/protocol/client.js").Client;
-/**
- * Configuration for the Astro integration of Arcjet.
- *
- * @template Rules
- *   List of rules.
- * @template Characteristics
- *   Characteristics to track a user by.
- */
-export type ArcjetOptions<Rules extends [...Array<Primitive | Product>], Characteristics extends readonly string[]> = Simplify<CoreOptions<Rules, Characteristics> & {
-    /**
-     * IP addresses and CIDR ranges of trusted load balancers and proxies
-     * (optional, example: `["100.100.100.100", "100.100.100.0/24"]`).
-     *
-     * Proxy services such as {@linkcode cloudflare} can also be included to read
-     * the real client IP from a service-specific header when the request comes
-     * from that service.
-     */
-    proxies?: Array<string | ProxyService>;
-}>;
-/**
- * Instance of the Astro integration of Arcjet.
- *
- * Primarily has a `protect()` method to make a decision about how a request
- * should be handled.
- *
- * @template Props
- *   Configuration.
- */
-export interface ArcjetAstro<Props extends PlainObject> {
-    /**
-     * Make a decision about how to handle a request.
-     *
-     * This will analyze the request locally where possible and otherwise call
-     * the Arcjet decision API.
-     *
-     * @param ctx
-     *   Additional context for this function call.
-     * @param request
-     *   Details about the {@linkcode ArcjetRequest} that Arcjet needs to make a
-     *   decision.
-     * @returns
-     *   Promise that resolves to an {@linkcode ArcjetDecision} indicating
-     *   Arcjet’s decision about the request.
-     */
-    protect(request: Request, ...props: MaybeProperties<Props>): Promise<ArcjetDecision>;
-    /**
-     * Augment the client with another rule.
-     *
-     * Useful for varying rules based on criteria in your handler such as
-     * different rate limit for logged in users.
-     *
-     * @template Rule
-     *   Type of rule.
-     * @param rule
-     *   Rule to add to Arcjet.
-     * @returns
-     *   Arcjet instance augmented with the given rule.
-     */
-    withRule<Rule extends ArcjetRule>(rule: Array<Rule>): ArcjetAstro<Props & (Rule extends ArcjetRule<infer P> ? P : {})>;
-}
-/**
- * Create a new Astro integration of Arcjet.
- *
- * @template Rules
- *   List of rules.
- * @template Characteristics
- *   Characteristics to track a user by.
- * @param options
- *   Configuration.
- * @returns
- *   Astro integration of Arcjet.
- */
-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

@@ -1,148 +0,0 @@
-import core__default from 'arcjet';
-export * from 'arcjet';
-import { readBodyWeb } from '@arcjet/body';
-import { parseProxies, findIp } from '@arcjet/ip';
-import { ArcjetHeaders } from '@arcjet/headers';
-import { logLevel, isDevelopment, baseUrl, platform } from '@arcjet/env';
-import { Logger } from '@arcjet/logger';
-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.
-const ipSymbol = Symbol.for("arcjet.ip");
-const env = {
-    ARCJET_BASE_URL,
-    ARCJET_ENV,
-    ARCJET_KEY,
-    ARCJET_LOG_LEVEL,
-    FIREBASE_CONFIG,
-    FLY_APP_NAME,
-    // `MODE` is only set on `import.meta.env`.
-    MODE: import.meta.env.MODE,
-    RENDER,
-    VERCEL,
-};
-/**
- * Create a remote client.
- *
- * @param options
- *   Configuration (optional).
- * @returns
- *   Client.
- */
-function createRemoteClient(options) {
-    const url = options?.baseUrl ?? baseUrl(env);
-    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 = "ASTRO";
-    const sdkVersion = "1.6.1";
-    return createClient({
-        transport,
-        baseUrl: url,
-        timeout,
-        sdkStack,
-        sdkVersion,
-    });
-}
-/**
- * Create a new Astro integration of Arcjet.
- *
- * @template Rules
- *   List of rules.
- * @template Characteristics
- *   Characteristics to track a user by.
- * @param options
- *   Configuration.
- * @returns
- *   Astro integration of Arcjet.
- */
-function createArcjetClient(options) {
-    const client = options.client ?? createRemoteClient();
-    const log = options.log
-        ? options.log
-        : new Logger({
-            level: logLevel(env),
-        });
-    const proxies = Array.isArray(options.proxies)
-        ? parseProxies(options.proxies)
-        : undefined;
-    if (isDevelopment(process.env)) {
-        log.warn("Arcjet will use 127.0.0.1 when missing public IP address in development mode");
-    }
-    function toArcjetRequest(request, props) {
-        const clientAddress = Reflect.get(request, ipSymbol);
-        if (!clientAddress) {
-            throw new Error("`protect()` cannot be used in prerendered pages");
-        }
-        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);
-        const xArcjetIp = isDevelopment(env)
-            ? headers.get("x-arcjet-ip")
-            : undefined;
-        let ip = xArcjetIp ||
-            findIp({ ip: clientAddress, headers }, { platform: platform(env), proxies });
-        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)) {
-                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) {
-        const client = {
-            withRule(rule) {
-                const client = aj.withRule(rule);
-                return withClient(client);
-            },
-            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;
-                    const expectedLengthString = request.headers.get("content-length");
-                    if (typeof expectedLengthString === "string") {
-                        expectedLength = parseInt(expectedLengthString, 10);
-                    }
-                    // HEAD and GET requests do not have a body.
-                    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);
-}
-
-export { createArcjetClient, createRemoteClient };

package/middleware.d.ts

@@ -1 +0,0 @@
-export declare const onRequest: import("astro").MiddlewareHandler;

package/middleware.js

@@ -1,14 +0,0 @@
-import { defineMiddleware } from 'astro/middleware';
-
-// 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.
-const ipSymbol = Symbol.for("arcjet.ip");
-const onRequest = defineMiddleware((ctx, next) => {
-    if (!ctx.isPrerendered) {
-        Reflect.set(ctx.request, ipSymbol, ctx.clientAddress);
-    }
-    return next();
-});
-
-export { onRequest };