@rei-standard/amsg-client 2.5.0 → 2.7.0

package/README.md

@@ -165,6 +165,8 @@ interface DeliverOptions {
 
   timeoutMs: number;                                       // 总预算（含 transport + grace）
   onChunk?: (payload: unknown) => Promise<void> | void;    // 可选 SSE 每帧钩子，抛错被吞
+  onRawRead?: (meta: RawReadMeta) => void;                 // 可选 SSE 原始读遥测，排查链路用；抛错被吞
+                                                            // 每次 reader.read() 后触发，保留 ':' 注释行
   postTransportGraceMs?: number;                           // transport 结束后等观察的 grace
                                                             // 默认 = min(remaining, max(5000, timeoutMs * 0.1))
                                                             // cancel 路径下生效的是 grace / 2
@@ -176,6 +178,13 @@ interface DeliverOptions {
                                                             // / X-Client-Token / Authorization
   authorization?: string;                                  // 透传成 Authorization header（与 sendInstant 对齐）
   endpointPath?: string;                                   // 默认 '/instant'，可改 '/continue' 续跑
+  compressRequest?: boolean | { thresholdBytes?: number }; // 可选请求体 gzip。不传/falsy = 关（行为不变）
+                                                            // true / {} = 开，阈值默认 16384 字节(16KB)
+                                                            // { thresholdBytes: N } = 开 + 自定义阈值
+                                                            // 仅当 body 超阈值且运行时有 CompressionStream 才压；
+                                                            // 否则发明文（优雅降级，绝不抛）。压时发 gzip 字节 +
+                                                            // 头 X-Amsg-Request-Encoding: gzip（非标准 Content-
+                                                            // Encoding），由接收端 gunzip。SSE / JSON 两路通用。
 }
 
 interface ObservedDeliveryReceipt {
@@ -183,8 +192,22 @@ interface ObservedDeliveryReceipt {
   sessionId?: string;        // ↑
   channel?: string;          // 'sw' / 'ipc' / 'native' / 'poll' / 任意诊断 label
 }
+
+interface RawReadMeta {
+  ts: number;                // Date.now()
+  byteLength: number;        // 本次 reader.read() 拿到的字节数
+  done: boolean;             // 流是否结束
+  textPreview: string;       // 本次数据解码后的前 120 字符，保留 ':' keepalive 注释行
+  status?: number;           // 仅首帧带：响应状态码
+  contentEncoding?: string | null;  // 仅首帧带：响应 Content-Encoding（查是否被边缘压缩）
+  contentType?: string | null;      // 仅首帧带
+}
 ```
 
+> `onRawRead` 是诊断钩子：SSE 解析层默认丢弃 `:` 注释行（含每秒一发的 keepalive），出问题时无从判断「静默期里到底有没有字节到达」。挂上它就能在 raw `reader.read()` 这一层看到每次读到的原始字节与 keepalive 帧。不传则零开销、行为不变。
+
+> `compressRequest` 用于大 body 上传：开启后，要发的 JSON 在上网线前 gzip（中文 + 重复结构压缩比很高），网线上字节小了就能在慢/不稳链路的发送超时之前传完，且上下文一字不动。仅当 body 超阈值且运行时支持 `CompressionStream` 才压，否则照常发明文；压缩出错也兜回明文，永不影响发送。压缩的是请求体，与响应 / `onChunk` / `onRawRead` 无关。接收端需按 `X-Amsg-Request-Encoding: gzip` 头自行解压。
+
 ### `delivery.mode` 必须显式选
 
 | mode | 何时用 | outcome 取值 |

package/dist/index.cjs

@@ -54,6 +54,25 @@ function classifyContentType(contentType) {
   if (/^application\/[\w.+-]+\+json$/.test(main)) return "json";
   return "unknown";
 }
+var COMPRESS_REQUEST_DEFAULT_THRESHOLD = 16384;
+var COMPRESS_REQUEST_HEADER = "X-Amsg-Request-Encoding";
+async function maybeCompressRequestBody(body, compressRequest) {
+  if (!compressRequest) return { body, header: null };
+  const threshold = typeof compressRequest === "object" && typeof compressRequest.thresholdBytes === "number" ? compressRequest.thresholdBytes : COMPRESS_REQUEST_DEFAULT_THRESHOLD;
+  try {
+    if (typeof CompressionStream === "undefined") return { body, header: null };
+    const bytes = new TextEncoder().encode(body);
+    if (bytes.length <= threshold) return { body, header: null };
+    const gz = new Uint8Array(
+      await new Response(
+        new Blob([bytes]).stream().pipeThrough(new CompressionStream("gzip"))
+      ).arrayBuffer()
+    );
+    return { body: gz, header: COMPRESS_REQUEST_HEADER };
+  } catch {
+    return { body, header: null };
+  }
+}
 var ReiClient = class {
   /**
    * @param {ReiClientConfig} config
@@ -315,7 +334,9 @@ var ReiClient = class {
       signal,
       headers,
       authorization,
-      endpointPath
+      endpointPath,
+      onRawRead,
+      compressRequest
     } = opts;
     if (!delivery || typeof delivery !== "object") {
       throw new TypeError("[rei-standard-amsg-client] deliver() requires opts.delivery (discriminated union)");
@@ -376,7 +397,9 @@ var ReiClient = class {
       try {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
-          onChunk: wrappedOnChunk
+          onChunk: wrappedOnChunk,
+          onRawRead,
+          compressRequest
         });
         if (finalized) return;
         transportEnded = true;
@@ -655,13 +678,17 @@ var ReiClient = class {
    *
    * @private
    * @param {{ url: string, headers: Record<string, string>, body: string }} built
-   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void, onRawRead?: (meta: RawReadMeta) => void, compressRequest?: boolean | { thresholdBytes?: number } }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
+   *   `compressRequest` opts the request body into gzip before `fetch` (see `DeliverOptions.compressRequest`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead, compressRequest } = opts;
     const { url, headers, body } = built;
-    const res = await fetch(url, { method: "POST", headers, body, signal });
+    const { body: wireBody, header: compressionHeader } = await maybeCompressRequestBody(body, compressRequest);
+    const wireHeaders = compressionHeader ? { ...headers, [compressionHeader]: "gzip" } : headers;
+    const res = await fetch(url, { method: "POST", headers: wireHeaders, body: wireBody, signal });
     if (!res.ok) {
       const text2 = await res.text().catch(() => "");
       const err = new Error(`Instant request failed: ${res.status} ${text2}`);
@@ -672,7 +699,15 @@ var ReiClient = class {
     const kind = classifyContentType(contentType);
     if (kind === "sse") {
       if (!res.body) throw new Error("Response body is null");
-      await this._consumeSseStream(res, { onPayload: onChunk });
+      await this._consumeSseStream(res, {
+        onPayload: onChunk,
+        onRawRead,
+        responseMeta: {
+          status: res.status,
+          contentEncoding: res.headers.get("content-encoding"),
+          contentType: res.headers.get("content-type")
+        }
+      });
       return { kind: "sse" };
     }
     if (kind === "json") {
@@ -689,15 +724,47 @@ var ReiClient = class {
    *
    * @private
    * @param {Response} res
-   * @param {{ onPayload?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{
+   *   onPayload?: (p: unknown) => Promise<void> | void,
+   *   onRawRead?: (meta: RawReadMeta) => void,
+   *   responseMeta?: { status?: number, contentEncoding?: string | null, contentType?: string | null }
+   * }} opts
+   *   `onRawRead` (if supplied) fires once per `reader.read()` before any SSE parsing/filtering — it sees
+   *   raw bytes including `: keepalive` comment frames. Throws from it are swallowed. `responseMeta` is
+   *   attached to the FIRST `onRawRead` call only. See `DeliverOptions.onRawRead`.
    * @returns {Promise<void>}
    */
   async _consumeSseStream(res, opts) {
-    const { onPayload } = opts;
+    const { onPayload, onRawRead, responseMeta } = opts;
     const reader = res.body.getReader();
     const decoder = new TextDecoder();
     let buffer = "";
     let thrown;
+    const previewDecoder = onRawRead ? new TextDecoder() : null;
+    let rawReadFired = false;
+    const emitRawRead = (done, value) => {
+      if (!onRawRead) return;
+      try {
+        let textPreview = "";
+        if (value && value.byteLength) {
+          textPreview = previewDecoder.decode(value).slice(0, 120);
+        }
+        const meta = {
+          ts: Date.now(),
+          byteLength: value && value.byteLength ? value.byteLength : 0,
+          done: !!done,
+          textPreview
+        };
+        if (!rawReadFired) {
+          meta.status = responseMeta ? responseMeta.status : void 0;
+          meta.contentEncoding = responseMeta ? responseMeta.contentEncoding : void 0;
+          meta.contentType = responseMeta ? responseMeta.contentType : void 0;
+        }
+        rawReadFired = true;
+        onRawRead(meta);
+      } catch {
+      }
+    };
     const processFrame = async (part) => {
       if (!part.trim()) return null;
       let eventName = "message";
@@ -739,6 +806,7 @@ ${piece}` : piece;
     try {
       while (true) {
         const { done, value } = await reader.read();
+        emitRawRead(done, value);
         if (done) {
           buffer += decoder.decode();
           const finalNormalized = buffer.replace(SSE_LINE_NORMALIZE, "\n");

package/dist/index.d.cts

@@ -195,6 +195,40 @@ const TEXT_ENCODER = new TextEncoder();
  *   `deliver()` don't silently drop the header.
  * @property {string}   [endpointPath='/instant']  - Path under the resolved instant base URL. Pass
  *   `'/continue'` for tool-result resume on amsg-instant 0.9.0+.
+ * @property {(meta: RawReadMeta) => void} [onRawRead] - Optional raw-read telemetry hook for the
+ *   foreground SSE transport. Fires once per `reader.read()` BEFORE any SSE parsing/filtering, so it
+ *   sees every byte that reached the client — including `: keepalive` comment frames that the parser
+ *   silently drops. Use it to tell "connection alive but no business data" apart from "no bytes flowing
+ *   at all" when diagnosing stalled streams. Purely observational: throws are swallowed and never affect
+ *   transport. Not invoked for the JSON transport.
+ * @property {boolean | { thresholdBytes?: number }} [compressRequest] - Opt-in gzip of the request
+ *   BODY before it is sent (applies to both the SSE and JSON transports — it compresses the request,
+ *   not the response). Omit / falsy = OFF and behavior is fully unchanged (backward compatible).
+ *   `true` or `{}` enables it at the default 16384-byte (16 KB) threshold; `{ thresholdBytes: N }`
+ *   sets a custom threshold. When enabled, the body is gzip-compressed only if its UTF-8 byte length
+ *   exceeds the threshold AND the runtime provides `CompressionStream`; otherwise it is sent as
+ *   plaintext (graceful degradation, never throws). On compression the request gains the custom
+ *   header `X-Amsg-Request-Encoding: gzip` (NOT standard `Content-Encoding`, which CDNs / proxies
+ *   would auto-decompress and double-decode) and the body is the raw gzip bytes — the receiving
+ *   worker is responsible for gunzipping. Use it when delivering large bodies over slow / flaky
+ *   uplinks where a big upload can outrun the connection's send timeout.
+ */
+
+/**
+ * Metadata for a single raw `reader.read()` on the SSE body, passed to
+ * `DeliverOptions.onRawRead`. The response-meta fields
+ * (`status` / `contentEncoding` / `contentType`) are only populated on the
+ * first invocation; later calls omit them.
+ *
+ * @typedef {Object} RawReadMeta
+ * @property {number}  ts                       - `Date.now()` at the moment the read resolved.
+ * @property {number}  byteLength               - Bytes in this chunk (`value?.byteLength ?? 0`).
+ * @property {boolean} done                     - The `done` flag from `reader.read()`.
+ * @property {string}  textPreview              - First ~120 chars of this chunk decoded as UTF-8,
+ *   WITHOUT any keepalive/comment filtering (so `:`-prefixed lines stay visible).
+ * @property {string|null} [contentEncoding]    - `res.headers.get('content-encoding')`. First call only.
+ * @property {string|null} [contentType]        - `res.headers.get('content-type')`. First call only.
+ * @property {number}  [status]                 - `res.status`. First call only.
  */
 
 /**
@@ -243,6 +277,68 @@ function classifyContentType(contentType) {
   return 'unknown';
 }
 
+/**
+ * Default size floor for request-body gzip: bodies at or below this are not
+ * worth compressing (the gzip header/overhead can outweigh the gain on tiny
+ * payloads). 16 KB matches the contract documented on `DeliverOptions.compressRequest`.
+ */
+const COMPRESS_REQUEST_DEFAULT_THRESHOLD = 16384;
+
+/**
+ * Custom request header used to mark a gzip-compressed body. Deliberately NOT
+ * the standard `Content-Encoding` — CDNs / reverse proxies (Cloudflare, etc.)
+ * auto-decompress `Content-Encoding: gzip` on the way in, which would double-
+ * decompress and corrupt the body. The receiving worker keys off this custom
+ * header to know it must gunzip the body itself.
+ */
+const COMPRESS_REQUEST_HEADER = 'X-Amsg-Request-Encoding';
+
+/**
+ * Optionally gzip a request body string before it hits `fetch`.
+ *
+ * Pure optimization with graceful degradation: returns the original plaintext
+ * body (and no extra header) whenever compression is disabled, the body is at
+ * or below the threshold, the runtime lacks `CompressionStream`, or anything
+ * throws. The wire bytes shrink (Chinese / repetitive JSON compresses ~5-8x)
+ * so large uploads finish before flaky links time out — without dropping any
+ * context. Decompression is the receiving worker's job (keyed off
+ * `X-Amsg-Request-Encoding: gzip`).
+ *
+ * @param {string} body - The already-serialized request body (plaintext JSON).
+ * @param {boolean | { thresholdBytes?: number } | undefined} compressRequest
+ *   `undefined`/falsy ⇒ disabled (no-op, backward compatible). `true` / `{}` ⇒
+ *   enabled at the 16 KB default. `{ thresholdBytes: N }` ⇒ enabled at N bytes.
+ * @returns {Promise<{ body: string | Uint8Array, header: string | null }>}
+ *   `header` is the gzip marker header name to set when compression happened,
+ *   or `null` to send plaintext with no extra header.
+ */
+async function maybeCompressRequestBody(body, compressRequest) {
+  // Disabled / no opt-in ⇒ behavior unchanged.
+  if (!compressRequest) return { body, header: null };
+
+  const threshold =
+    typeof compressRequest === 'object' && typeof compressRequest.thresholdBytes === 'number'
+      ? compressRequest.thresholdBytes
+      : COMPRESS_REQUEST_DEFAULT_THRESHOLD;
+
+  try {
+    if (typeof CompressionStream === 'undefined') return { body, header: null };
+
+    const bytes = new TextEncoder().encode(body);
+    if (bytes.length <= threshold) return { body, header: null };
+
+    const gz = new Uint8Array(
+      await new Response(
+        new Blob([bytes]).stream().pipeThrough(new CompressionStream('gzip'))
+      ).arrayBuffer()
+    );
+    return { body: gz, header: COMPRESS_REQUEST_HEADER };
+  } catch {
+    // Compression is an optimization, never a failure mode: fall back to plaintext.
+    return { body, header: null };
+  }
+}
+
 class ReiClient {
   /**
    * @param {ReiClientConfig} config
@@ -536,7 +632,8 @@ class ReiClient {
     }
     const {
       delivery, timeoutMs, onChunk, postTransportGraceMs,
-      signal, headers, authorization, endpointPath,
+      signal, headers, authorization, endpointPath, onRawRead,
+      compressRequest,
     } = opts;
 
     if (!delivery || typeof delivery !== 'object') {
@@ -629,6 +726,8 @@ class ReiClient {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
           onChunk: wrappedOnChunk,
+          onRawRead,
+          compressRequest,
         });
         if (finalized) return;
         transportEnded = true;
@@ -981,14 +1080,23 @@ class ReiClient {
    *
    * @private
    * @param {{ url: string, headers: Record<string, string>, body: string }} built
-   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void, onRawRead?: (meta: RawReadMeta) => void, compressRequest?: boolean | { thresholdBytes?: number } }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
+   *   `compressRequest` opts the request body into gzip before `fetch` (see `DeliverOptions.compressRequest`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead, compressRequest } = opts;
     const { url, headers, body } = built;
 
-    const res = await fetch(url, { method: 'POST', headers, body, signal });
+    // Optionally gzip the request body (opt-in, graceful fallback to plaintext).
+    const { body: wireBody, header: compressionHeader } =
+      await maybeCompressRequestBody(body, compressRequest);
+    const wireHeaders = compressionHeader
+      ? { ...headers, [compressionHeader]: 'gzip' }
+      : headers;
+
+    const res = await fetch(url, { method: 'POST', headers: wireHeaders, body: wireBody, signal });
 
     if (!res.ok) {
       const text = await res.text().catch(() => '');
@@ -1001,7 +1109,15 @@ class ReiClient {
     const kind = classifyContentType(contentType);
     if (kind === 'sse') {
       if (!res.body) throw new Error('Response body is null');
-      await this._consumeSseStream(res, { onPayload: onChunk });
+      await this._consumeSseStream(res, {
+        onPayload: onChunk,
+        onRawRead,
+        responseMeta: {
+          status: res.status,
+          contentEncoding: res.headers.get('content-encoding'),
+          contentType: res.headers.get('content-type'),
+        },
+      });
       return { kind: 'sse' };
     }
     if (kind === 'json') {
@@ -1019,16 +1135,54 @@ class ReiClient {
    *
    * @private
    * @param {Response} res
-   * @param {{ onPayload?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{
+   *   onPayload?: (p: unknown) => Promise<void> | void,
+   *   onRawRead?: (meta: RawReadMeta) => void,
+   *   responseMeta?: { status?: number, contentEncoding?: string | null, contentType?: string | null }
+   * }} opts
+   *   `onRawRead` (if supplied) fires once per `reader.read()` before any SSE parsing/filtering — it sees
+   *   raw bytes including `: keepalive` comment frames. Throws from it are swallowed. `responseMeta` is
+   *   attached to the FIRST `onRawRead` call only. See `DeliverOptions.onRawRead`.
    * @returns {Promise<void>}
    */
   async _consumeSseStream(res, opts) {
-    const { onPayload } = opts;
+    const { onPayload, onRawRead, responseMeta } = opts;
     const reader = res.body.getReader();
     const decoder = new TextDecoder();
     let buffer = '';
     let thrown;
 
+    // Raw read-loop telemetry (opt-in via onRawRead). Kept completely
+    // separate from the parsing path: a one-shot decoder for the preview so
+    // it never perturbs the streaming `decoder` above, and the first call
+    // carries response meta (status / encoding / content-type).
+    const previewDecoder = onRawRead ? new TextDecoder() : null;
+    let rawReadFired = false;
+    const emitRawRead = (done, value) => {
+      if (!onRawRead) return;
+      try {
+        let textPreview = '';
+        if (value && value.byteLength) {
+          // One-shot decode (no { stream: true }) so we don't carry state
+          // between calls and disturb the main buffer's decoder.
+          textPreview = previewDecoder.decode(value).slice(0, 120);
+        }
+        const meta = {
+          ts: Date.now(),
+          byteLength: value && value.byteLength ? value.byteLength : 0,
+          done: !!done,
+          textPreview,
+        };
+        if (!rawReadFired) {
+          meta.status = responseMeta ? responseMeta.status : undefined;
+          meta.contentEncoding = responseMeta ? responseMeta.contentEncoding : undefined;
+          meta.contentType = responseMeta ? responseMeta.contentType : undefined;
+        }
+        rawReadFired = true;
+        onRawRead(meta);
+      } catch { /* telemetry must never break the transport */ }
+    };
+
     // Parse one SSE frame body (lines between two terminators). Returns
     // `'done'` if the frame signals end-of-stream so the caller can
     // unwind without consuming further frames. Throws on `event: error`.
@@ -1071,6 +1225,7 @@ class ReiClient {
     try {
       while (true) {
         const { done, value } = await reader.read();
+        emitRawRead(done, value);
         if (done) {
           // Flush any tail bytes the decoder held back (partial UTF-8
           // sequences split across the final chunk boundary).

package/dist/index.d.ts

@@ -195,6 +195,40 @@ const TEXT_ENCODER = new TextEncoder();
  *   `deliver()` don't silently drop the header.
  * @property {string}   [endpointPath='/instant']  - Path under the resolved instant base URL. Pass
  *   `'/continue'` for tool-result resume on amsg-instant 0.9.0+.
+ * @property {(meta: RawReadMeta) => void} [onRawRead] - Optional raw-read telemetry hook for the
+ *   foreground SSE transport. Fires once per `reader.read()` BEFORE any SSE parsing/filtering, so it
+ *   sees every byte that reached the client — including `: keepalive` comment frames that the parser
+ *   silently drops. Use it to tell "connection alive but no business data" apart from "no bytes flowing
+ *   at all" when diagnosing stalled streams. Purely observational: throws are swallowed and never affect
+ *   transport. Not invoked for the JSON transport.
+ * @property {boolean | { thresholdBytes?: number }} [compressRequest] - Opt-in gzip of the request
+ *   BODY before it is sent (applies to both the SSE and JSON transports — it compresses the request,
+ *   not the response). Omit / falsy = OFF and behavior is fully unchanged (backward compatible).
+ *   `true` or `{}` enables it at the default 16384-byte (16 KB) threshold; `{ thresholdBytes: N }`
+ *   sets a custom threshold. When enabled, the body is gzip-compressed only if its UTF-8 byte length
+ *   exceeds the threshold AND the runtime provides `CompressionStream`; otherwise it is sent as
+ *   plaintext (graceful degradation, never throws). On compression the request gains the custom
+ *   header `X-Amsg-Request-Encoding: gzip` (NOT standard `Content-Encoding`, which CDNs / proxies
+ *   would auto-decompress and double-decode) and the body is the raw gzip bytes — the receiving
+ *   worker is responsible for gunzipping. Use it when delivering large bodies over slow / flaky
+ *   uplinks where a big upload can outrun the connection's send timeout.
+ */
+
+/**
+ * Metadata for a single raw `reader.read()` on the SSE body, passed to
+ * `DeliverOptions.onRawRead`. The response-meta fields
+ * (`status` / `contentEncoding` / `contentType`) are only populated on the
+ * first invocation; later calls omit them.
+ *
+ * @typedef {Object} RawReadMeta
+ * @property {number}  ts                       - `Date.now()` at the moment the read resolved.
+ * @property {number}  byteLength               - Bytes in this chunk (`value?.byteLength ?? 0`).
+ * @property {boolean} done                     - The `done` flag from `reader.read()`.
+ * @property {string}  textPreview              - First ~120 chars of this chunk decoded as UTF-8,
+ *   WITHOUT any keepalive/comment filtering (so `:`-prefixed lines stay visible).
+ * @property {string|null} [contentEncoding]    - `res.headers.get('content-encoding')`. First call only.
+ * @property {string|null} [contentType]        - `res.headers.get('content-type')`. First call only.
+ * @property {number}  [status]                 - `res.status`. First call only.
  */
 
 /**
@@ -243,6 +277,68 @@ function classifyContentType(contentType) {
   return 'unknown';
 }
 
+/**
+ * Default size floor for request-body gzip: bodies at or below this are not
+ * worth compressing (the gzip header/overhead can outweigh the gain on tiny
+ * payloads). 16 KB matches the contract documented on `DeliverOptions.compressRequest`.
+ */
+const COMPRESS_REQUEST_DEFAULT_THRESHOLD = 16384;
+
+/**
+ * Custom request header used to mark a gzip-compressed body. Deliberately NOT
+ * the standard `Content-Encoding` — CDNs / reverse proxies (Cloudflare, etc.)
+ * auto-decompress `Content-Encoding: gzip` on the way in, which would double-
+ * decompress and corrupt the body. The receiving worker keys off this custom
+ * header to know it must gunzip the body itself.
+ */
+const COMPRESS_REQUEST_HEADER = 'X-Amsg-Request-Encoding';
+
+/**
+ * Optionally gzip a request body string before it hits `fetch`.
+ *
+ * Pure optimization with graceful degradation: returns the original plaintext
+ * body (and no extra header) whenever compression is disabled, the body is at
+ * or below the threshold, the runtime lacks `CompressionStream`, or anything
+ * throws. The wire bytes shrink (Chinese / repetitive JSON compresses ~5-8x)
+ * so large uploads finish before flaky links time out — without dropping any
+ * context. Decompression is the receiving worker's job (keyed off
+ * `X-Amsg-Request-Encoding: gzip`).
+ *
+ * @param {string} body - The already-serialized request body (plaintext JSON).
+ * @param {boolean | { thresholdBytes?: number } | undefined} compressRequest
+ *   `undefined`/falsy ⇒ disabled (no-op, backward compatible). `true` / `{}` ⇒
+ *   enabled at the 16 KB default. `{ thresholdBytes: N }` ⇒ enabled at N bytes.
+ * @returns {Promise<{ body: string | Uint8Array, header: string | null }>}
+ *   `header` is the gzip marker header name to set when compression happened,
+ *   or `null` to send plaintext with no extra header.
+ */
+async function maybeCompressRequestBody(body, compressRequest) {
+  // Disabled / no opt-in ⇒ behavior unchanged.
+  if (!compressRequest) return { body, header: null };
+
+  const threshold =
+    typeof compressRequest === 'object' && typeof compressRequest.thresholdBytes === 'number'
+      ? compressRequest.thresholdBytes
+      : COMPRESS_REQUEST_DEFAULT_THRESHOLD;
+
+  try {
+    if (typeof CompressionStream === 'undefined') return { body, header: null };
+
+    const bytes = new TextEncoder().encode(body);
+    if (bytes.length <= threshold) return { body, header: null };
+
+    const gz = new Uint8Array(
+      await new Response(
+        new Blob([bytes]).stream().pipeThrough(new CompressionStream('gzip'))
+      ).arrayBuffer()
+    );
+    return { body: gz, header: COMPRESS_REQUEST_HEADER };
+  } catch {
+    // Compression is an optimization, never a failure mode: fall back to plaintext.
+    return { body, header: null };
+  }
+}
+
 class ReiClient {
   /**
    * @param {ReiClientConfig} config
@@ -536,7 +632,8 @@ class ReiClient {
     }
     const {
       delivery, timeoutMs, onChunk, postTransportGraceMs,
-      signal, headers, authorization, endpointPath,
+      signal, headers, authorization, endpointPath, onRawRead,
+      compressRequest,
     } = opts;
 
     if (!delivery || typeof delivery !== 'object') {
@@ -629,6 +726,8 @@ class ReiClient {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
           onChunk: wrappedOnChunk,
+          onRawRead,
+          compressRequest,
         });
         if (finalized) return;
         transportEnded = true;
@@ -981,14 +1080,23 @@ class ReiClient {
    *
    * @private
    * @param {{ url: string, headers: Record<string, string>, body: string }} built
-   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void, onRawRead?: (meta: RawReadMeta) => void, compressRequest?: boolean | { thresholdBytes?: number } }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
+   *   `compressRequest` opts the request body into gzip before `fetch` (see `DeliverOptions.compressRequest`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead, compressRequest } = opts;
     const { url, headers, body } = built;
 
-    const res = await fetch(url, { method: 'POST', headers, body, signal });
+    // Optionally gzip the request body (opt-in, graceful fallback to plaintext).
+    const { body: wireBody, header: compressionHeader } =
+      await maybeCompressRequestBody(body, compressRequest);
+    const wireHeaders = compressionHeader
+      ? { ...headers, [compressionHeader]: 'gzip' }
+      : headers;
+
+    const res = await fetch(url, { method: 'POST', headers: wireHeaders, body: wireBody, signal });
 
     if (!res.ok) {
       const text = await res.text().catch(() => '');
@@ -1001,7 +1109,15 @@ class ReiClient {
     const kind = classifyContentType(contentType);
     if (kind === 'sse') {
       if (!res.body) throw new Error('Response body is null');
-      await this._consumeSseStream(res, { onPayload: onChunk });
+      await this._consumeSseStream(res, {
+        onPayload: onChunk,
+        onRawRead,
+        responseMeta: {
+          status: res.status,
+          contentEncoding: res.headers.get('content-encoding'),
+          contentType: res.headers.get('content-type'),
+        },
+      });
       return { kind: 'sse' };
     }
     if (kind === 'json') {
@@ -1019,16 +1135,54 @@ class ReiClient {
    *
    * @private
    * @param {Response} res
-   * @param {{ onPayload?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{
+   *   onPayload?: (p: unknown) => Promise<void> | void,
+   *   onRawRead?: (meta: RawReadMeta) => void,
+   *   responseMeta?: { status?: number, contentEncoding?: string | null, contentType?: string | null }
+   * }} opts
+   *   `onRawRead` (if supplied) fires once per `reader.read()` before any SSE parsing/filtering — it sees
+   *   raw bytes including `: keepalive` comment frames. Throws from it are swallowed. `responseMeta` is
+   *   attached to the FIRST `onRawRead` call only. See `DeliverOptions.onRawRead`.
    * @returns {Promise<void>}
    */
   async _consumeSseStream(res, opts) {
-    const { onPayload } = opts;
+    const { onPayload, onRawRead, responseMeta } = opts;
     const reader = res.body.getReader();
     const decoder = new TextDecoder();
     let buffer = '';
     let thrown;
 
+    // Raw read-loop telemetry (opt-in via onRawRead). Kept completely
+    // separate from the parsing path: a one-shot decoder for the preview so
+    // it never perturbs the streaming `decoder` above, and the first call
+    // carries response meta (status / encoding / content-type).
+    const previewDecoder = onRawRead ? new TextDecoder() : null;
+    let rawReadFired = false;
+    const emitRawRead = (done, value) => {
+      if (!onRawRead) return;
+      try {
+        let textPreview = '';
+        if (value && value.byteLength) {
+          // One-shot decode (no { stream: true }) so we don't carry state
+          // between calls and disturb the main buffer's decoder.
+          textPreview = previewDecoder.decode(value).slice(0, 120);
+        }
+        const meta = {
+          ts: Date.now(),
+          byteLength: value && value.byteLength ? value.byteLength : 0,
+          done: !!done,
+          textPreview,
+        };
+        if (!rawReadFired) {
+          meta.status = responseMeta ? responseMeta.status : undefined;
+          meta.contentEncoding = responseMeta ? responseMeta.contentEncoding : undefined;
+          meta.contentType = responseMeta ? responseMeta.contentType : undefined;
+        }
+        rawReadFired = true;
+        onRawRead(meta);
+      } catch { /* telemetry must never break the transport */ }
+    };
+
     // Parse one SSE frame body (lines between two terminators). Returns
     // `'done'` if the frame signals end-of-stream so the caller can
     // unwind without consuming further frames. Throws on `event: error`.
@@ -1071,6 +1225,7 @@ class ReiClient {
     try {
       while (true) {
         const { done, value } = await reader.read();
+        emitRawRead(done, value);
         if (done) {
           // Flush any tail bytes the decoder held back (partial UTF-8
           // sequences split across the final chunk boundary).

package/dist/index.mjs

@@ -32,6 +32,25 @@ function classifyContentType(contentType) {
   if (/^application\/[\w.+-]+\+json$/.test(main)) return "json";
   return "unknown";
 }
+var COMPRESS_REQUEST_DEFAULT_THRESHOLD = 16384;
+var COMPRESS_REQUEST_HEADER = "X-Amsg-Request-Encoding";
+async function maybeCompressRequestBody(body, compressRequest) {
+  if (!compressRequest) return { body, header: null };
+  const threshold = typeof compressRequest === "object" && typeof compressRequest.thresholdBytes === "number" ? compressRequest.thresholdBytes : COMPRESS_REQUEST_DEFAULT_THRESHOLD;
+  try {
+    if (typeof CompressionStream === "undefined") return { body, header: null };
+    const bytes = new TextEncoder().encode(body);
+    if (bytes.length <= threshold) return { body, header: null };
+    const gz = new Uint8Array(
+      await new Response(
+        new Blob([bytes]).stream().pipeThrough(new CompressionStream("gzip"))
+      ).arrayBuffer()
+    );
+    return { body: gz, header: COMPRESS_REQUEST_HEADER };
+  } catch {
+    return { body, header: null };
+  }
+}
 var ReiClient = class {
   /**
    * @param {ReiClientConfig} config
@@ -293,7 +312,9 @@ var ReiClient = class {
       signal,
       headers,
       authorization,
-      endpointPath
+      endpointPath,
+      onRawRead,
+      compressRequest
     } = opts;
     if (!delivery || typeof delivery !== "object") {
       throw new TypeError("[rei-standard-amsg-client] deliver() requires opts.delivery (discriminated union)");
@@ -354,7 +375,9 @@ var ReiClient = class {
       try {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
-          onChunk: wrappedOnChunk
+          onChunk: wrappedOnChunk,
+          onRawRead,
+          compressRequest
         });
         if (finalized) return;
         transportEnded = true;
@@ -633,13 +656,17 @@ var ReiClient = class {
    *
    * @private
    * @param {{ url: string, headers: Record<string, string>, body: string }} built
-   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{ signal: AbortSignal, onChunk?: (p: unknown) => Promise<void> | void, onRawRead?: (meta: RawReadMeta) => void, compressRequest?: boolean | { thresholdBytes?: number } }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
+   *   `compressRequest` opts the request body into gzip before `fetch` (see `DeliverOptions.compressRequest`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead, compressRequest } = opts;
     const { url, headers, body } = built;
-    const res = await fetch(url, { method: "POST", headers, body, signal });
+    const { body: wireBody, header: compressionHeader } = await maybeCompressRequestBody(body, compressRequest);
+    const wireHeaders = compressionHeader ? { ...headers, [compressionHeader]: "gzip" } : headers;
+    const res = await fetch(url, { method: "POST", headers: wireHeaders, body: wireBody, signal });
     if (!res.ok) {
       const text2 = await res.text().catch(() => "");
       const err = new Error(`Instant request failed: ${res.status} ${text2}`);
@@ -650,7 +677,15 @@ var ReiClient = class {
     const kind = classifyContentType(contentType);
     if (kind === "sse") {
       if (!res.body) throw new Error("Response body is null");
-      await this._consumeSseStream(res, { onPayload: onChunk });
+      await this._consumeSseStream(res, {
+        onPayload: onChunk,
+        onRawRead,
+        responseMeta: {
+          status: res.status,
+          contentEncoding: res.headers.get("content-encoding"),
+          contentType: res.headers.get("content-type")
+        }
+      });
       return { kind: "sse" };
     }
     if (kind === "json") {
@@ -667,15 +702,47 @@ var ReiClient = class {
    *
    * @private
    * @param {Response} res
-   * @param {{ onPayload?: (p: unknown) => Promise<void> | void }} opts
+   * @param {{
+   *   onPayload?: (p: unknown) => Promise<void> | void,
+   *   onRawRead?: (meta: RawReadMeta) => void,
+   *   responseMeta?: { status?: number, contentEncoding?: string | null, contentType?: string | null }
+   * }} opts
+   *   `onRawRead` (if supplied) fires once per `reader.read()` before any SSE parsing/filtering — it sees
+   *   raw bytes including `: keepalive` comment frames. Throws from it are swallowed. `responseMeta` is
+   *   attached to the FIRST `onRawRead` call only. See `DeliverOptions.onRawRead`.
    * @returns {Promise<void>}
    */
   async _consumeSseStream(res, opts) {
-    const { onPayload } = opts;
+    const { onPayload, onRawRead, responseMeta } = opts;
     const reader = res.body.getReader();
     const decoder = new TextDecoder();
     let buffer = "";
     let thrown;
+    const previewDecoder = onRawRead ? new TextDecoder() : null;
+    let rawReadFired = false;
+    const emitRawRead = (done, value) => {
+      if (!onRawRead) return;
+      try {
+        let textPreview = "";
+        if (value && value.byteLength) {
+          textPreview = previewDecoder.decode(value).slice(0, 120);
+        }
+        const meta = {
+          ts: Date.now(),
+          byteLength: value && value.byteLength ? value.byteLength : 0,
+          done: !!done,
+          textPreview
+        };
+        if (!rawReadFired) {
+          meta.status = responseMeta ? responseMeta.status : void 0;
+          meta.contentEncoding = responseMeta ? responseMeta.contentEncoding : void 0;
+          meta.contentType = responseMeta ? responseMeta.contentType : void 0;
+        }
+        rawReadFired = true;
+        onRawRead(meta);
+      } catch {
+      }
+    };
     const processFrame = async (part) => {
       if (!part.trim()) return null;
       let eventName = "message";
@@ -717,6 +784,7 @@ ${piece}` : piece;
     try {
       while (true) {
         const { done, value } = await reader.read();
+        emitRawRead(done, value);
         if (done) {
           buffer += decoder.decode();
           const finalNormalized = buffer.replace(SSE_LINE_NORMALIZE, "\n");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rei-standard/amsg-client",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "ReiStandard Active Messaging browser client SDK — also re-exports shared push types, builders, and guards from @rei-standard/amsg-shared",
   "repository": {
     "type": "git",