@rei-standard/amsg-client 2.5.0 → 2.6.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
@@ -183,8 +185,20 @@ 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 帧。不传则零开销、行为不变。
+
 ### `delivery.mode` 必须显式选
 
 | mode | 何时用 | outcome 取值 |

package/dist/index.cjs

@@ -315,7 +315,8 @@ var ReiClient = class {
       signal,
       headers,
       authorization,
-      endpointPath
+      endpointPath,
+      onRawRead
     } = opts;
     if (!delivery || typeof delivery !== "object") {
       throw new TypeError("[rei-standard-amsg-client] deliver() requires opts.delivery (discriminated union)");
@@ -376,7 +377,8 @@ var ReiClient = class {
       try {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
-          onChunk: wrappedOnChunk
+          onChunk: wrappedOnChunk,
+          onRawRead
         });
         if (finalized) return;
         transportEnded = true;
@@ -655,11 +657,12 @@ 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 }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead } = opts;
     const { url, headers, body } = built;
     const res = await fetch(url, { method: "POST", headers, body, signal });
     if (!res.ok) {
@@ -672,7 +675,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 +700,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 +782,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,29 @@ 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.
+ */
+
+/**
+ * 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.
  */
 
 /**
@@ -536,7 +559,7 @@ class ReiClient {
     }
     const {
       delivery, timeoutMs, onChunk, postTransportGraceMs,
-      signal, headers, authorization, endpointPath,
+      signal, headers, authorization, endpointPath, onRawRead,
     } = opts;
 
     if (!delivery || typeof delivery !== 'object') {
@@ -629,6 +652,7 @@ class ReiClient {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
           onChunk: wrappedOnChunk,
+          onRawRead,
         });
         if (finalized) return;
         transportEnded = true;
@@ -981,11 +1005,12 @@ 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 }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead } = opts;
     const { url, headers, body } = built;
 
     const res = await fetch(url, { method: 'POST', headers, body, signal });
@@ -1001,7 +1026,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 +1052,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 +1142,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,29 @@ 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.
+ */
+
+/**
+ * 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.
  */
 
 /**
@@ -536,7 +559,7 @@ class ReiClient {
     }
     const {
       delivery, timeoutMs, onChunk, postTransportGraceMs,
-      signal, headers, authorization, endpointPath,
+      signal, headers, authorization, endpointPath, onRawRead,
     } = opts;
 
     if (!delivery || typeof delivery !== 'object') {
@@ -629,6 +652,7 @@ class ReiClient {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
           onChunk: wrappedOnChunk,
+          onRawRead,
         });
         if (finalized) return;
         transportEnded = true;
@@ -981,11 +1005,12 @@ 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 }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead } = opts;
     const { url, headers, body } = built;
 
     const res = await fetch(url, { method: 'POST', headers, body, signal });
@@ -1001,7 +1026,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 +1052,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 +1142,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

@@ -293,7 +293,8 @@ var ReiClient = class {
       signal,
       headers,
       authorization,
-      endpointPath
+      endpointPath,
+      onRawRead
     } = opts;
     if (!delivery || typeof delivery !== "object") {
       throw new TypeError("[rei-standard-amsg-client] deliver() requires opts.delivery (discriminated union)");
@@ -354,7 +355,8 @@ var ReiClient = class {
       try {
         const result = await this._runInstantTransport(built, {
           signal: internalAbort.signal,
-          onChunk: wrappedOnChunk
+          onChunk: wrappedOnChunk,
+          onRawRead
         });
         if (finalized) return;
         transportEnded = true;
@@ -633,11 +635,12 @@ 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 }} opts
+   *   `onRawRead` is forwarded to the SSE consumer for raw read-loop telemetry (see `DeliverOptions.onRawRead`).
    * @returns {Promise<{ kind: 'sse' } | { kind: 'json', body: unknown }>}
    */
   async _runInstantTransport(built, opts) {
-    const { signal, onChunk } = opts;
+    const { signal, onChunk, onRawRead } = opts;
     const { url, headers, body } = built;
     const res = await fetch(url, { method: "POST", headers, body, signal });
     if (!res.ok) {
@@ -650,7 +653,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 +678,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 +760,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.6.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",