@arcjet/astro 1.0.0-beta.11 → 1.0.0-beta.13

package/index.d.ts

@@ -2,31 +2,31 @@ import type { BotOptions, EmailOptions, FilterOptions, FixedWindowRateLimitOptio
 import type { AstroIntegration } from "astro";
 type IntegrationRule<Characteristics extends readonly string[]> = {
     type: "shield";
-    options?: ShieldOptions;
+    options: ShieldOptions;
 } | {
     type: "bot";
-    options?: BotOptions;
+    options: BotOptions;
 } | {
     type: "email";
-    options?: EmailOptions;
+    options: EmailOptions;
 } | {
     type: "filter";
     options: FilterOptions;
 } | {
     type: "sensitiveInfo";
-    options?: SensitiveInfoOptions<never>;
+    options: SensitiveInfoOptions<never>;
 } | {
     type: "fixedWindow";
-    options?: FixedWindowRateLimitOptions<Characteristics>;
+    options: FixedWindowRateLimitOptions<Characteristics>;
 } | {
     type: "slidingWindow";
-    options?: SlidingWindowRateLimitOptions<Characteristics>;
+    options: SlidingWindowRateLimitOptions<Characteristics>;
 } | {
     type: "tokenBucket";
-    options?: TokenBucketRateLimitOptions<Characteristics>;
+    options: TokenBucketRateLimitOptions<Characteristics>;
 } | {
     type: "protectSignup";
-    options?: ProtectSignupOptions<Characteristics>;
+    options: ProtectSignupOptions<Characteristics>;
 };
 /**
  * Configuration for the Astro integration of Arcjet.
@@ -74,9 +74,9 @@ type ArcjetIntegrationOptions<Characteristics extends readonly string[]> = {
  * @returns
  *   Astro integration Shield rule to provide to the SDK in the `rules` field.
  */
-export declare function shield(options?: ShieldOptions): {
+export declare function shield(options: ShieldOptions): {
     readonly type: "shield";
-    readonly options: ShieldOptions | undefined;
+    readonly options: ShieldOptions;
 };
 /**
  * Arcjet bot detection rule.
@@ -98,9 +98,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): {
+export declare function detectBot(options: BotOptions): {
     readonly type: "bot";
-    readonly options: BotOptions | undefined;
+    readonly options: BotOptions;
 };
 /**
  * Arcjet email validation rule.
@@ -119,19 +119,41 @@ 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): {
+export declare function validateEmail(options: EmailOptions): {
     readonly type: "email";
-    readonly options: EmailOptions | undefined;
+    readonly options: EmailOptions;
 };
 /**
  * Arcjet filter rule.
  *
- * Applying this rule lets you write expressions to match against requests.
+ * Applying this rule lets you block requests using Wireshark-like display
+ * filter expressions over HTTP headers, IP addresses, and other request
+ * fields.
+ * You can quickly enforce rules like allow/deny by country, network, or
+ * `user-agent` pattern.
+ *
+ * See the [reference guide](https://docs.arcjet.com/filters/reference) for
+ * more info on the expression language fields, functions, and values.
  *
  * @param options
- *   Configuration for the filter rule (required).
+ *   Configuration (required).
  * @returns
  *   Astro integration Filter rule to provide to the SDK in the `rules` field.
+ *
+ * @example
+ *   In this example, the expression matches non-VPN GET requests from the US.
+ *   Requests matching the expression are allowed, all others are denied.
+ *
+ *   ```ts
+ *   filter({
+ *     allow: [
+ *       'http.request.method eq "GET" and ip.src.country eq "US" and not ip.src.vpn',
+ *     ],
+ *     mode: "LIVE",
+ *   })
+ *   ```
+ *
+ * @link https://docs.arcjet.com/filters/reference
  */
 export declare function filter(options: FilterOptions): {
     readonly type: "filter";
@@ -155,9 +177,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>): {
+export declare function sensitiveInfo(options: SensitiveInfoOptions<never>): {
     readonly type: "sensitiveInfo";
-    readonly options: SensitiveInfoOptions<never> | undefined;
+    readonly options: SensitiveInfoOptions<never>;
 };
 /**
  * Arcjet fixed window rate limiting rule.
@@ -185,9 +207,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>): {
+export declare function fixedWindow<Characteristics extends readonly string[]>(options: FixedWindowRateLimitOptions<Characteristics>): {
     readonly type: "fixedWindow";
-    readonly options: FixedWindowRateLimitOptions<Characteristics> | undefined;
+    readonly options: FixedWindowRateLimitOptions<Characteristics>;
 };
 /**
  * Arcjet sliding window rate limiting rule.
@@ -208,9 +230,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>): {
+export declare function slidingWindow<Characteristics extends readonly string[]>(options: SlidingWindowRateLimitOptions<Characteristics>): {
     readonly type: "slidingWindow";
-    readonly options: SlidingWindowRateLimitOptions<Characteristics> | undefined;
+    readonly options: SlidingWindowRateLimitOptions<Characteristics>;
 };
 /**
  * Arcjet token bucket rate limiting rule.
@@ -232,9 +254,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>): {
+export declare function tokenBucket<Characteristics extends readonly string[]>(options: TokenBucketRateLimitOptions<Characteristics>): {
     readonly type: "tokenBucket";
-    readonly options: TokenBucketRateLimitOptions<Characteristics> | undefined;
+    readonly options: TokenBucketRateLimitOptions<Characteristics>;
 };
 /**
  * Arcjet signup form protection rule.
@@ -260,9 +282,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>): {
+export declare function protectSignup<Characteristics extends readonly string[]>(options: ProtectSignupOptions<Characteristics>): {
     readonly type: "protectSignup";
-    readonly options: ProtectSignupOptions<Characteristics> | undefined;
+    readonly options: ProtectSignupOptions<Characteristics>;
 };
 /**
  * Configuration for {@linkcode createRemoteClient}.
@@ -274,13 +296,13 @@ export type RemoteClientOptions = {
      * Defaults to the environment variable `ARCJET_BASE_URL` (if that value
      * is known and allowed) and the standard production API otherwise.
      */
-    baseUrl?: string;
+    baseUrl?: string | undefined;
     /**
      * Timeout in milliseconds for the Decide API (optional).
      *
      * Defaults to `500` in production and `1000` in development.
      */
-    timeout?: number;
+    timeout?: number | undefined;
 };
 /**
  * Create a remote client.
@@ -290,7 +312,7 @@ export type RemoteClientOptions = {
  * @returns
  *   Client.
  */
-export declare function createRemoteClient({ baseUrl, timeout }: RemoteClientOptions): {
+export declare function createRemoteClient(options?: RemoteClientOptions | undefined): {
     readonly baseUrl: string | undefined;
     readonly timeout: number | undefined;
 };

package/index.js

@@ -7,123 +7,112 @@ const validateProxies = z.array(z.string());
 const validateCharacteristics = z.array(z.string());
 const validateClientOptions = z
     .object({
-    baseUrl: z.string(),
-    timeout: z.number(),
+    baseUrl: z.string().optional(),
+    timeout: z.number().optional(),
 })
     .strict()
     .optional();
+// TODO: once `arcjet` core has `exactOptionalProperties` we can use
+// `satisfies z.ZodType<ShieldOptions>` and such here.
 const validateShieldOptions = z
     .object({
-    mode: validateMode,
+    mode: validateMode.optional(),
 })
-    .strict()
-    .optional();
-const validateBotOptions = z
-    .union([
+    .strict();
+const validateBotOptions = z.union([
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         allow: z.array(z.string()),
     })
         .strict(),
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         deny: z.array(z.string()),
     })
         .strict(),
-])
-    .optional();
-const validateEmailOptions = z
-    .union([
+]);
+const validateEmailOptions = z.union([
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         allow: z.array(z.string()),
-        requireTopLevelDomain: z.boolean(),
-        allowDomainLiteral: z.boolean(),
+        requireTopLevelDomain: z.boolean().optional(),
+        allowDomainLiteral: z.boolean().optional(),
     })
         .strict(),
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         deny: z.array(z.string()),
-        requireTopLevelDomain: z.boolean(),
-        allowDomainLiteral: z.boolean(),
+        requireTopLevelDomain: z.boolean().optional(),
+        allowDomainLiteral: z.boolean().optional(),
     })
         .strict(),
-])
-    .optional();
-const validateFilterOptions = z
-    .union([
+]);
+const validateFilterOptions = z.union([
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         allow: z.array(z.string()),
     })
         .strict(),
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         deny: z.array(z.string()),
     })
         .strict(),
-])
-    .optional();
-const validateSensitiveInfoOptions = z
-    .union([
+]);
+const validateSensitiveInfoOptions = z.union([
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         allow: z.array(z.string()),
-        contextWindowSize: z.number(),
+        contextWindowSize: z.number().optional(),
     })
         .strict(),
     z
         .object({
-        mode: validateMode,
+        mode: validateMode.optional(),
         deny: z.array(z.string()),
-        contextWindowSize: z.number(),
+        contextWindowSize: z.number().optional(),
     })
         .strict(),
-])
-    .optional();
+]);
 const validateFixedWindowOptions = z
     .object({
-    mode: validateMode,
-    characteristics: validateCharacteristics,
+    mode: validateMode.optional(),
+    characteristics: validateCharacteristics.optional(),
     window: z.union([z.string(), z.number()]),
     max: z.number(),
 })
-    .strict()
-    .optional();
+    .strict();
 const validateSlidingWindowOptions = z
     .object({
-    mode: validateMode,
-    characteristics: validateCharacteristics,
+    mode: validateMode.optional(),
+    characteristics: validateCharacteristics.optional(),
     interval: z.union([z.string(), z.number()]),
     max: z.number(),
 })
-    .strict()
-    .optional();
+    .strict();
 const validateTokenBucketOptions = z
     .object({
-    mode: validateMode,
-    characteristics: validateCharacteristics,
+    mode: validateMode.optional(),
+    characteristics: validateCharacteristics.optional(),
     refillRate: z.number(),
     interval: z.union([z.string(), z.number()]),
     capacity: z.number(),
 })
-    .strict()
-    .optional();
+    .strict();
 const validateProtectSignupOptions = z
     .object({
     rateLimit: validateSlidingWindowOptions,
     bots: validateBotOptions,
     email: validateEmailOptions,
 })
-    .strict()
-    .optional();
+    .strict();
 function validateAndSerialize(schema, value) {
     const v = schema.parse(value);
     return v ? JSON.stringify(v) : "";
@@ -268,12 +257,34 @@ function validateEmail(options) {
 /**
  * Arcjet filter rule.
  *
- * Applying this rule lets you write expressions to match against requests.
+ * Applying this rule lets you block requests using Wireshark-like display
+ * filter expressions over HTTP headers, IP addresses, and other request
+ * fields.
+ * You can quickly enforce rules like allow/deny by country, network, or
+ * `user-agent` pattern.
+ *
+ * See the [reference guide](https://docs.arcjet.com/filters/reference) for
+ * more info on the expression language fields, functions, and values.
  *
  * @param options
- *   Configuration for the filter rule (required).
+ *   Configuration (required).
  * @returns
  *   Astro integration Filter rule to provide to the SDK in the `rules` field.
+ *
+ * @example
+ *   In this example, the expression matches non-VPN GET requests from the US.
+ *   Requests matching the expression are allowed, all others are denied.
+ *
+ *   ```ts
+ *   filter({
+ *     allow: [
+ *       'http.request.method eq "GET" and ip.src.country eq "US" and not ip.src.vpn',
+ *     ],
+ *     mode: "LIVE",
+ *   })
+ *   ```
+ *
+ * @link https://docs.arcjet.com/filters/reference
  */
 function filter(options) {
     return { type: "filter", options };
@@ -328,7 +339,10 @@ function sensitiveInfo(options) {
  *   Astro integration Fixed window rule to provide to the SDK in the `rules` field.
  */
 function fixedWindow(options) {
-    return { type: "fixedWindow", options };
+    return {
+        type: "fixedWindow",
+        options,
+    };
 }
 // Note: please keep JSDocs in sync with `arcjet` core.
 /**
@@ -351,7 +365,10 @@ function fixedWindow(options) {
  *   Astro integration Sliding window rule to provide to the SDK in the `rules` field.
  */
 function slidingWindow(options) {
-    return { type: "slidingWindow", options };
+    return {
+        type: "slidingWindow",
+        options,
+    };
 }
 // Note: please keep JSDocs in sync with `arcjet` core.
 /**
@@ -375,7 +392,10 @@ function slidingWindow(options) {
  *   Astro integration Token bucket rule to provide to the SDK in the `rules` field.
  */
 function tokenBucket(options) {
-    return { type: "tokenBucket", options };
+    return {
+        type: "tokenBucket",
+        options,
+    };
 }
 // Note: please keep JSDocs in sync with `arcjet` core.
 /**
@@ -403,7 +423,10 @@ function tokenBucket(options) {
  *   Astro integration Signup form protection rule to provide to the SDK in the `rules` field.
  */
 function protectSignup(options) {
-    return { type: "protectSignup", options };
+    return {
+        type: "protectSignup",
+        options,
+    };
 }
 /**
  * Create a remote client.
@@ -413,8 +436,9 @@ function protectSignup(options) {
  * @returns
  *   Client.
  */
-function createRemoteClient({ baseUrl, timeout }) {
-    return { baseUrl, timeout };
+function createRemoteClient(options) {
+    const settings = options ?? {};
+    return { baseUrl: settings.baseUrl, timeout: settings.timeout };
 }
 /**
  * Create a new Astro integration of Arcjet.

package/internal.js

@@ -50,7 +50,7 @@ function createRemoteClient(options) {
     // Transport is the HTTP client that the client uses to make requests.
     const transport = createTransport(url);
     const sdkStack = "ASTRO";
-    const sdkVersion = "1.0.0-beta.11";
+    const sdkVersion = "1.0.0-beta.13";
     return createClient({
         transport,
         baseUrl: url,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/astro",
-  "version": "1.0.0-beta.11",
+  "version": "1.0.0-beta.13",
   "description": "Arcjet helps developers protect their Astro sites in just a few lines of code. Bot detection. Rate limiting. Email validation. Attack protection. Data redaction. A developer-first approach to security.",
   "keywords": [
     "analyze",
@@ -47,26 +47,28 @@
     "build": "rollup --config rollup.config.js",
     "lint": "eslint .",
     "prepublishOnly": "npm run build",
-    "test": "npm run build && npm run lint"
+    "test-api": "node --test",
+    "test-coverage": "node --experimental-test-coverage --test",
+    "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {
-    "@arcjet/env": "1.0.0-beta.11",
-    "@arcjet/headers": "1.0.0-beta.11",
-    "@arcjet/ip": "1.0.0-beta.11",
-    "@arcjet/logger": "1.0.0-beta.11",
-    "@arcjet/protocol": "1.0.0-beta.11",
-    "@arcjet/transport": "1.0.0-beta.11",
-    "arcjet": "1.0.0-beta.11"
+    "@arcjet/env": "1.0.0-beta.13",
+    "@arcjet/headers": "1.0.0-beta.13",
+    "@arcjet/ip": "1.0.0-beta.13",
+    "@arcjet/logger": "1.0.0-beta.13",
+    "@arcjet/protocol": "1.0.0-beta.13",
+    "@arcjet/transport": "1.0.0-beta.13",
+    "arcjet": "1.0.0-beta.13"
   },
   "peerDependencies": {
     "astro": "^5.9.3"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-beta.11",
-    "@arcjet/rollup-config": "1.0.0-beta.11",
-    "@rollup/wasm-node": "4.50.0",
-    "astro": "5.13.5",
-    "eslint": "9.34.0",
+    "@arcjet/eslint-config": "1.0.0-beta.13",
+    "@arcjet/rollup-config": "1.0.0-beta.13",
+    "@rollup/wasm-node": "4.52.3",
+    "astro": "5.14.1",
+    "eslint": "9.36.0",
     "typescript": "5.9.2"
   },
   "publishConfig": {