@arcjet/decorate 1.0.0-beta.10 → 1.0.0-beta.11

package/index.d.ts

@@ -1,28 +1,40 @@
 import type { ArcjetDecision } from "@arcjet/protocol";
 interface HeaderLike {
-    has(name: string): boolean;
     get(name: string): string | null;
+    has(name: string): boolean;
     set(name: string, value: string): void;
 }
-export interface ArcjetCanDecorate {
-    has?: (name: string) => boolean;
-    get?: (name: string) => string | null;
-    set?: (name: string, value: string) => void;
-    headers?: HeaderLike;
-    headersSent?: boolean;
-    hasHeader?: (name: string) => boolean;
-    getHeader?: (name: string) => number | string | string[] | undefined;
-    setHeader?: (name: string, value: number | string | ReadonlyArray<string>) => unknown;
+interface ResponseLike {
+    headers: HeaderLike;
+}
+interface OutgoingMessageLike {
+    getHeader: (name: string) => string[] | number | string | undefined;
+    headersSent: boolean;
+    hasHeader: (name: string) => boolean;
+    setHeader: (name: string, value: ReadonlyArray<string> | number | string) => unknown;
 }
 /**
- * Decorates an object with `RateLimit` and `RateLimit-Policy` headers based
- * on an {@link ArcjetDecision} and conforming to the [Rate Limit fields for
+ * Decorable value.
+ *
+ * Something that looks like `Headers` (Fetch),
+ * `OutgoingMessage` (Node.js), or
+ * `Response` (Fetch).
+ */
+export type ArcjetCanDecorate = HeaderLike | OutgoingMessageLike | ResponseLike;
+/**
+ * Decorate something based on an Arcjet decision with rate limit headers.
+ *
+ * Sets `RateLimit-Policy` and `RateLimit` and conform to the
+ * [Rate Limit fields for
  * HTTP](https://ietf-wg-httpapi.github.io/ratelimit-headers/draft-ietf-httpapi-ratelimit-headers.html)
  * draft specification.
  *
- * @param value The object to decorate—must be similar to {@link Headers}, {@link Response} or
- * {@link OutgoingMessage}.
- * @param decision The {@link ArcjetDecision} that was made by calling `protect()` on the SDK.
+ * @param value
+ *   Decorable value.
+ * @param decision
+ *   Decision from `protect()`.
+ * @returns
+ *   Nothing.
  */
 export declare function setRateLimitHeaders(value: ArcjetCanDecorate, decision: ArcjetDecision): void;
 export {};

package/index.js

@@ -13,13 +13,14 @@ function isHeaderLike(value) {
     return false;
 }
 function isResponseLike(value) {
-    if (typeof value.headers === "undefined") {
+    if (!("headers" in value) || typeof value.headers === "undefined") {
         return false;
     }
     return isHeaderLike(value.headers);
 }
 function isOutgoingMessageLike(response) {
-    if (typeof response.headersSent !== "boolean") {
+    if (!("headersSent" in response) ||
+        typeof response.headersSent !== "boolean") {
         return false;
     }
     if (typeof response.hasHeader !== "function") {
@@ -71,14 +72,19 @@ function nearestLimit(current, next) {
     return next;
 }
 /**
- * Decorates an object with `RateLimit` and `RateLimit-Policy` headers based
- * on an {@link ArcjetDecision} and conforming to the [Rate Limit fields for
+ * Decorate something based on an Arcjet decision with rate limit headers.
+ *
+ * Sets `RateLimit-Policy` and `RateLimit` and conform to the
+ * [Rate Limit fields for
  * HTTP](https://ietf-wg-httpapi.github.io/ratelimit-headers/draft-ietf-httpapi-ratelimit-headers.html)
  * draft specification.
  *
- * @param value The object to decorate—must be similar to {@link Headers}, {@link Response} or
- * {@link OutgoingMessage}.
- * @param decision The {@link ArcjetDecision} that was made by calling `protect()` on the SDK.
+ * @param value
+ *   Decorable value.
+ * @param decision
+ *   Decision from `protect()`.
+ * @returns
+ *   Nothing.
  */
 function setRateLimitHeaders(value, decision) {
     const rateLimitReasons = decision.results

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/decorate",
-  "version": "1.0.0-beta.10",
+  "version": "1.0.0-beta.11",
   "description": "Arcjet utilities for decorating responses with information",
   "keywords": [
     "arcjet",
@@ -43,16 +43,15 @@
     "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {
-    "@arcjet/protocol": "1.0.0-beta.10",
-    "@arcjet/sprintf": "1.0.0-beta.10"
+    "@arcjet/protocol": "1.0.0-beta.11",
+    "@arcjet/sprintf": "1.0.0-beta.11"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-beta.10",
-    "@arcjet/rollup-config": "1.0.0-beta.10",
-    "@arcjet/tsconfig": "1.0.0-beta.10",
-    "@rollup/wasm-node": "4.46.2",
-    "@types/node": "18.18.0",
-    "eslint": "9.32.0",
+    "@arcjet/eslint-config": "1.0.0-beta.11",
+    "@arcjet/rollup-config": "1.0.0-beta.11",
+    "@rollup/wasm-node": "4.50.0",
+    "@types/node": "24.3.0",
+    "eslint": "9.34.0",
     "typescript": "5.9.2"
   },
   "publishConfig": {