@stainlessdev/xray-core 0.5.1 → 0.6.0

package/dist/{types-BA4cE85r.d.ts → types-CB9CGfc5.d.ts}

@@ -20,7 +20,17 @@ interface RedactionConfig {
     replacement: string;
 }
 interface RequestIdConfig {
+    /**
+     * Incoming request header name to read request IDs from. Set or overwrite
+     * this header in your own middleware before X-ray runs if you don't want to
+     * trust client-supplied IDs. This is normalized to lowercase during
+     * configuration.
+     */
     header: string;
+    /**
+     * Generate a UUIDv7 when no request ID is present on the request or header.
+     * When disabled and no ID is found, X-ray uses an empty string.
+     */
     generate: boolean;
 }
 interface RouteConfig {
@@ -37,6 +47,11 @@ interface XrayConfig {
     exporter?: Partial<ExporterConfig>;
     capture?: Partial<CaptureConfig>;
     redaction?: Partial<RedactionConfig>;
+    /**
+     * Request ID resolution settings. The header is read from incoming request headers.
+     * Set or overwrite that header before X-ray runs if you don't want to trust
+     * client-supplied IDs.
+     */
     requestId?: Partial<RequestIdConfig>;
     route?: Partial<RouteConfig>;
 }
@@ -117,6 +132,12 @@ interface NormalizedRequest {
     route?: string;
     headers: Record<string, string | string[]>;
     body?: CapturedBody;
+    /**
+     * Optional explicit request ID. If omitted, X-ray reads from incoming request
+     * headers (and generates a UUIDv7 if enabled). When generation is disabled
+     * and no ID is found, X-ray uses an empty string. Set or overwrite that
+     * header before X-ray runs if you don't want to trust client-supplied IDs.
+     */
     requestId?: string;
     remoteAddress?: string;
     startTimeMs: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainlessdev/xray-core",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Core instrumentation for Stainless X-ray request logging",
   "files": [
     "dist"