@arcjet/astro 1.6.0 → 1.7.0-rc.0

package/{index.d.ts → dist/index.d.ts}

@@ -1,38 +1,38 @@
-import type { BotOptions, DetectPromptInjectionOptions, EmailOptions, FilterOptions, FixedWindowRateLimitOptions, ProtectSignupOptions, SensitiveInfoOptions, ShieldOptions, SlidingWindowRateLimitOptions, TokenBucketRateLimitOptions } from "arcjet";
-import type { ProxyService } from "@arcjet/ip";
-import type { AstroIntegration } from "astro";
-export { cloudflare } from "@arcjet/ip";
-export type { ProxyService } from "@arcjet/ip";
+import { ProxyService, ProxyService as ProxyService$1, cloudflare } from "@arcjet/ip";
+import { BotOptions, DetectPromptInjectionOptions, EmailOptions, FilterOptions, FixedWindowRateLimitOptions, ProtectSignupOptions, SensitiveInfoOptions, ShieldOptions, SlidingWindowRateLimitOptions, TokenBucketRateLimitOptions } from "arcjet";
+import { AstroIntegration } from "astro";
+
+//#region src/index.d.ts
 type IntegrationRule<Characteristics extends readonly string[]> = {
-    type: "shield";
-    options: ShieldOptions;
+  type: "shield";
+  options: ShieldOptions;
 } | {
-    type: "bot";
-    options: BotOptions;
+  type: "bot";
+  options: BotOptions;
 } | {
-    type: "email";
-    options: EmailOptions;
+  type: "email";
+  options: EmailOptions;
 } | {
-    type: "filter";
-    options: FilterOptions;
+  type: "filter";
+  options: FilterOptions;
 } | {
-    type: "sensitiveInfo";
-    options: SensitiveInfoOptions<undefined>;
+  type: "sensitiveInfo";
+  options: SensitiveInfoOptions<undefined>;
 } | {
-    type: "fixedWindow";
-    options: FixedWindowRateLimitOptions<Characteristics>;
+  type: "fixedWindow";
+  options: FixedWindowRateLimitOptions<Characteristics>;
 } | {
-    type: "slidingWindow";
-    options: SlidingWindowRateLimitOptions<Characteristics>;
+  type: "slidingWindow";
+  options: SlidingWindowRateLimitOptions<Characteristics>;
 } | {
-    type: "tokenBucket";
-    options: TokenBucketRateLimitOptions<Characteristics>;
+  type: "tokenBucket";
+  options: TokenBucketRateLimitOptions<Characteristics>;
 } | {
-    type: "protectSignup";
-    options: ProtectSignupOptions<Characteristics>;
+  type: "protectSignup";
+  options: ProtectSignupOptions<Characteristics>;
 } | {
-    type: "detectPromptInjection";
-    options: DetectPromptInjectionOptions;
+  type: "detectPromptInjection";
+  options: DetectPromptInjectionOptions;
 };
 /**
  * Configuration for the Astro integration of Arcjet.
@@ -40,33 +40,33 @@ type IntegrationRule<Characteristics extends readonly string[]> = {
  * @template Characteristics
  *   Characteristics to track a user by.
  */
-export type ArcjetOptions<Characteristics extends readonly string[]> = {
-    /**
-     * Integration rules to apply when protecting a request (required).
-     *
-     * These rules are *different* from those exposed from `arcjet` core.
-     * You have to import them from this integration (`@arcjet/astro`) instead.
-     */
-    rules: IntegrationRule<Characteristics>[];
-    /**
-     * Characteristics to track a user by (default: `["ip.src"]`).
-     *
-     * Can also be passed to rules.
-     */
-    characteristics?: Characteristics;
-    /**
-     * Configuration for the default client (optional).
-     */
-    client?: RemoteClientOptions;
-    /**
-     * 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>;
+type ArcjetOptions<Characteristics extends readonly string[]> = {
+  /**
+   * Integration rules to apply when protecting a request (required).
+   *
+   * These rules are *different* from those exposed from `arcjet` core.
+   * You have to import them from this integration (`@arcjet/astro`) instead.
+   */
+  rules: IntegrationRule<Characteristics>[];
+  /**
+   * Characteristics to track a user by (default: `["ip.src"]`).
+   *
+   * Can also be passed to rules.
+   */
+  characteristics?: Characteristics;
+  /**
+   * Configuration for the default client (optional).
+   */
+  client?: RemoteClientOptions;
+  /**
+   * 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$1>;
 };
 /**
  * Arcjet Shield WAF rule.
@@ -84,9 +84,9 @@ export type ArcjetOptions<Characteristics extends readonly string[]> = {
  * @returns
  *   Astro integration Shield rule to provide to the SDK in the `rules` field.
  */
-export declare function shield(options: ShieldOptions): {
-    readonly type: "shield";
-    readonly options: ShieldOptions;
+declare function shield(options: ShieldOptions): {
+  readonly type: "shield";
+  readonly options: ShieldOptions;
 };
 /**
  * Arcjet bot detection rule.
@@ -108,9 +108,9 @@ export declare function shield(options: ShieldOptions): {
  * @returns
  *   Astro integration Bot rule to provide to the SDK in the `rules` field.
  */
-export declare function detectBot(options: BotOptions): {
-    readonly type: "bot";
-    readonly options: BotOptions;
+declare function detectBot(options: BotOptions): {
+  readonly type: "bot";
+  readonly options: BotOptions;
 };
 /**
  * Arcjet email validation rule.
@@ -129,9 +129,9 @@ export declare function detectBot(options: BotOptions): {
  * @returns
  *   Astro integration Email rule to provide to the SDK in the `rules` field.
  */
-export declare function validateEmail(options: EmailOptions): {
-    readonly type: "email";
-    readonly options: EmailOptions;
+declare function validateEmail(options: EmailOptions): {
+  readonly type: "email";
+  readonly options: EmailOptions;
 };
 /**
  * Arcjet filter rule.
@@ -165,9 +165,9 @@ export declare function validateEmail(options: EmailOptions): {
  *
  * @link https://docs.arcjet.com/filters/reference
  */
-export declare function filter(options: FilterOptions): {
-    readonly type: "filter";
-    readonly options: FilterOptions;
+declare function filter(options: FilterOptions): {
+  readonly type: "filter";
+  readonly options: FilterOptions;
 };
 /**
  * Arcjet sensitive information detection rule.
@@ -187,9 +187,9 @@ export declare function filter(options: FilterOptions): {
  * @returns
  *   Astro integration Sensitive information rule to provide to the SDK in the `rules` field.
  */
-export declare function sensitiveInfo(options: SensitiveInfoOptions<never>): {
-    readonly type: "sensitiveInfo";
-    readonly options: SensitiveInfoOptions<never>;
+declare function sensitiveInfo(options: SensitiveInfoOptions<never>): {
+  readonly type: "sensitiveInfo";
+  readonly options: SensitiveInfoOptions<never>;
 };
 /**
  * Arcjet fixed window rate limiting rule.
@@ -217,9 +217,9 @@ export declare function sensitiveInfo(options: SensitiveInfoOptions<never>): {
  * @returns
  *   Astro integration Fixed window rule to provide to the SDK in the `rules` field.
  */
-export declare function fixedWindow<Characteristics extends readonly string[]>(options: FixedWindowRateLimitOptions<Characteristics>): {
-    readonly type: "fixedWindow";
-    readonly options: FixedWindowRateLimitOptions<Characteristics>;
+declare function fixedWindow<Characteristics extends readonly string[]>(options: FixedWindowRateLimitOptions<Characteristics>): {
+  readonly type: "fixedWindow";
+  readonly options: FixedWindowRateLimitOptions<Characteristics>;
 };
 /**
  * Arcjet sliding window rate limiting rule.
@@ -240,9 +240,9 @@ export declare function fixedWindow<Characteristics extends readonly string[]>(o
  * @returns
  *   Astro integration Sliding window rule to provide to the SDK in the `rules` field.
  */
-export declare function slidingWindow<Characteristics extends readonly string[]>(options: SlidingWindowRateLimitOptions<Characteristics>): {
-    readonly type: "slidingWindow";
-    readonly options: SlidingWindowRateLimitOptions<Characteristics>;
+declare function slidingWindow<Characteristics extends readonly string[]>(options: SlidingWindowRateLimitOptions<Characteristics>): {
+  readonly type: "slidingWindow";
+  readonly options: SlidingWindowRateLimitOptions<Characteristics>;
 };
 /**
  * Arcjet token bucket rate limiting rule.
@@ -264,9 +264,9 @@ export declare function slidingWindow<Characteristics extends readonly string[]>
  * @returns
  *   Astro integration Token bucket rule to provide to the SDK in the `rules` field.
  */
-export declare function tokenBucket<Characteristics extends readonly string[]>(options: TokenBucketRateLimitOptions<Characteristics>): {
-    readonly type: "tokenBucket";
-    readonly options: TokenBucketRateLimitOptions<Characteristics>;
+declare function tokenBucket<Characteristics extends readonly string[]>(options: TokenBucketRateLimitOptions<Characteristics>): {
+  readonly type: "tokenBucket";
+  readonly options: TokenBucketRateLimitOptions<Characteristics>;
 };
 /**
  * Arcjet signup form protection rule.
@@ -292,9 +292,9 @@ export declare function tokenBucket<Characteristics extends readonly string[]>(o
  * @returns
  *   Astro integration Signup form protection rule to provide to the SDK in the `rules` field.
  */
-export declare function protectSignup<Characteristics extends readonly string[]>(options: ProtectSignupOptions<Characteristics>): {
-    readonly type: "protectSignup";
-    readonly options: ProtectSignupOptions<Characteristics>;
+declare function protectSignup<Characteristics extends readonly string[]>(options: ProtectSignupOptions<Characteristics>): {
+  readonly type: "protectSignup";
+  readonly options: ProtectSignupOptions<Characteristics>;
 };
 /**
  * Arcjet prompt injection detection rule.
@@ -310,9 +310,9 @@ export declare function protectSignup<Characteristics extends readonly string[]>
  * @returns
  *   Astro integration Prompt injection detection rule to provide to the SDK in the `rules` field.
  */
-export declare function detectPromptInjection(options?: DetectPromptInjectionOptions): {
-    readonly type: "detectPromptInjection";
-    readonly options: DetectPromptInjectionOptions;
+declare function detectPromptInjection(options?: DetectPromptInjectionOptions): {
+  readonly type: "detectPromptInjection";
+  readonly options: DetectPromptInjectionOptions;
 };
 /**
  * Arcjet prompt injection detection rule.
@@ -320,24 +320,24 @@ export declare function detectPromptInjection(options?: DetectPromptInjectionOpt
  * @deprecated
  *   Use `detectPromptInjection` instead.
  */
-export declare const experimental_detectPromptInjection: typeof detectPromptInjection;
+declare const experimental_detectPromptInjection: typeof detectPromptInjection;
 /**
  * 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 | undefined;
-    /**
-     * Timeout in milliseconds for the Decide API (optional).
-     *
-     * Defaults to `500` in production and `1000` in development.
-     */
-    timeout?: number | undefined;
+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 | undefined;
+  /**
+   * Timeout in milliseconds for the Decide API (optional).
+   *
+   * Defaults to `500` in production and `1000` in development.
+   */
+  timeout?: number | undefined;
 };
 /**
  * Create a remote client.
@@ -347,9 +347,9 @@ export type RemoteClientOptions = {
  * @returns
  *   Client.
  */
-export declare function createRemoteClient(options?: RemoteClientOptions | undefined): {
-    readonly baseUrl: string | undefined;
-    readonly timeout: number | undefined;
+declare function createRemoteClient(options?: RemoteClientOptions | undefined): {
+  readonly baseUrl: string | undefined;
+  readonly timeout: number | undefined;
 };
 /**
  * Create a new Astro integration of Arcjet.
@@ -361,4 +361,6 @@ export declare function createRemoteClient(options?: RemoteClientOptions | undef
  * @returns
  *   Astro integration of Arcjet.
  */
-export default function arcjet<Characteristics extends readonly string[]>(options?: ArcjetOptions<Characteristics>): AstroIntegration;
+declare function arcjet<Characteristics extends readonly string[]>(options?: ArcjetOptions<Characteristics>): AstroIntegration;
+//#endregion
+export { ArcjetOptions, type ProxyService, RemoteClientOptions, cloudflare, createRemoteClient, arcjet as default, detectBot, detectPromptInjection, experimental_detectPromptInjection, filter, fixedWindow, protectSignup, sensitiveInfo, shield, slidingWindow, tokenBucket, validateEmail };