@ahoo-wang/fetcher-eventstream 3.16.6 → 3.16.8

package/dist/serverSentEventTransformStream.d.ts

@@ -1,10 +1,7 @@
+import { SafeTransformer, TransformerPhase } from './safeTransformer';
 /**
  * Represents a message sent in an event stream.
  *
- * This interface defines the structure of Server-Sent Events (SSE) as specified by the W3C.
- * Each event contains metadata and data that can be processed by clients to handle real-time
- * updates from the server.
- *
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format}
  */
 export interface ServerSentEvent {
@@ -17,81 +14,31 @@ export interface ServerSentEvent {
     /** The reconnection interval (in milliseconds) to wait before retrying the connection */
     retry?: number;
 }
+/**
+ * Constants for Server-Sent Event field names.
+ */
 export declare class ServerSentEventFields {
-    /** The field name for event ID */
     static readonly ID = "id";
-    /** The field name for retry interval */
     static readonly RETRY = "retry";
-    /** The field name for event type */
     static readonly EVENT = "event";
-    /** The field name for event data */
     static readonly DATA = "data";
 }
 /**
- * Transformer responsible for converting a string stream into a ServerSentEvent object stream.
- *
- * Implements the Transformer interface for processing data transformation in TransformStream.
- * This transformer handles the parsing of Server-Sent Events (SSE) according to the W3C specification.
- * It processes incoming text chunks and converts them into structured ServerSentEvent objects.
+ * Transformer responsible for converting a string stream into a
+ * ServerSentEvent object stream, following the W3C SSE specification.
  */
-export declare class ServerSentEventTransformer implements Transformer<string, ServerSentEvent> {
+export declare class ServerSentEventTransformer extends SafeTransformer<string, ServerSentEvent> {
     private currentEventState;
-    /**
-     * Reset the current event state to default values.
-     * This method is called after processing each complete event or when an error occurs.
-     */
     private resetEventState;
-    /**
-     * Transform input string chunk into ServerSentEvent object.
-     * This method processes individual chunks of text data, parsing them according to the SSE format.
-     * It handles:
-     * - Empty lines (used as event separators)
-     * - Comment lines (starting with ':')
-     * - Field lines (field: value format)
-     * - Event completion and emission
-     *
-     * @param chunk Input string chunk
-     * @param controller Controller for controlling the transform stream
-     */
-    transform(chunk: string, controller: TransformStreamDefaultController<ServerSentEvent>): void;
-    /**
-     * Called when the stream ends, used to process remaining data.
-     *
-     * @param controller Controller for controlling the transform stream
-     */
-    flush(controller: TransformStreamDefaultController<ServerSentEvent>): void;
+    protected onError(_error: unknown, _phase: TransformerPhase): void;
+    protected onTransform(chunk: string, controller: TransformStreamDefaultController<ServerSentEvent>): void;
+    protected onFlush(controller: TransformStreamDefaultController<ServerSentEvent>): void;
 }
 /**
- * A TransformStream that converts a stream of strings into a stream of ServerSentEvent objects.
- *
- * This class provides a convenient way to transform raw text streams containing Server-Sent Events
- * into structured event objects. It wraps the ServerSentEventTransformer in a TransformStream
- * for easy integration with other stream processing pipelines.
- *
- * The stream processes SSE format text and emits ServerSentEvent objects as they are completed.
- * Events are separated by empty lines, and the stream handles partial events across multiple chunks.
- *
- * @example
- * ```typescript
- * // Create a transform stream
- * const sseStream = new ServerSentEventTransformStream();
- *
- * // Pipe a text stream through it
- * const eventStream = textStream.pipeThrough(sseStream);
- *
- * // Consume the events
- * for await (const event of eventStream) {
- *   console.log('Event:', event.event, 'Data:', event.data);
- * }
- * ```
+ * A TransformStream that converts a stream of strings into a stream of
+ * ServerSentEvent objects.
  */
 export declare class ServerSentEventTransformStream extends TransformStream<string, ServerSentEvent> {
-    /**
-     * Creates a new ServerSentEventTransformStream instance.
-     *
-     * Initializes the stream with a ServerSentEventTransformer that handles
-     * the parsing of SSE format text into structured events.
-     */
     constructor();
 }
 //# sourceMappingURL=serverSentEventTransformStream.d.ts.map

package/dist/serverSentEventTransformStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serverSentEventTransformStream.d.ts","sourceRoot":"","sources":["../src/serverSentEventTransformStream.ts"],"names":[],"mappings":"AAaA;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,yFAAyF;IACzF,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAWD,qBAAa,qBAAqB;IAChC,kCAAkC;IAClC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ;IAC1B,wCAAwC;IACxC,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAChC,oCAAoC;IACpC,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAChC,oCAAoC;IACpC,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;CAC/B;AAmED;;;;;;GAMG;AACH,qBAAa,0BAA2B,YAAW,WAAW,CAC5D,MAAM,EACN,eAAe,CAChB;IAEC,OAAO,CAAC,iBAAiB,CAKvB;IAEF;;;OAGG;IACH,OAAO,CAAC,eAAe;IAOvB;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC;IA+D/D;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC;CAsBpE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,8BAA+B,SAAQ,eAAe,CACjE,MAAM,EACN,eAAe,CAChB;IACC;;;;;OAKG;;CAIJ"}
+{"version":3,"file":"serverSentEventTransformStream.d.ts","sourceRoot":"","sources":["../src/serverSentEventTransformStream.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,eAAe,EAAE,KAAK,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE3E;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,yFAAyF;IACzF,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ;IAC1B,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAK,WAAW;IAChC,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU;CAC/B;AA4CD;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,eAAe,CAC7D,MAAM,EACN,eAAe,CAChB;IACC,OAAO,CAAC,iBAAiB,CAKvB;IAEF,OAAO,CAAC,eAAe;cAOJ,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAI3E,SAAS,CAAC,WAAW,CACnB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC,GAC5D,IAAI;IA4CP,SAAS,CAAC,OAAO,CACf,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC,GAC5D,IAAI;CAeR;AAED;;;GAGG;AACH,qBAAa,8BAA+B,SAAQ,eAAe,CACjE,MAAM,EACN,eAAe,CAChB;;CAIA"}

package/dist/textLineTransformStream.d.ts

@@ -1,64 +1,29 @@
-export declare class TextLineTransformer implements Transformer<string, string> {
+import { SafeTransformer } from './safeTransformer';
+/**
+ * Transformer that splits text into lines.
+ *
+ * Accumulates chunks of text and splits them by newline characters ('\n'),
+ * emitting each complete line as a separate chunk. Handles partial lines
+ * that span multiple input chunks by maintaining an internal buffer.
+ */
+export declare class TextLineTransformer extends SafeTransformer<string, string> {
     private buffer;
-    /**
-     * Transform input string chunk by splitting it into lines.
-     *
-     * @param chunk Input string chunk
-     * @param controller Controller for controlling the transform stream
-     */
-    transform(chunk: string, controller: TransformStreamDefaultController<string>): void;
-    /**
-     * Flush remaining buffer when the stream ends.
-     *
-     * @param controller Controller for controlling the transform stream
-     */
-    flush(controller: TransformStreamDefaultController<string>): void;
+    protected onTransform(chunk: string, controller: TransformStreamDefaultController<string>): void;
+    protected onFlush(controller: TransformStreamDefaultController<string>): void;
 }
 /**
  * A TransformStream that splits text into lines.
  *
- * This class provides a convenient way to transform a stream of text chunks into a stream
- * of individual lines. It wraps the TextLineTransformer in a TransformStream for easy
- * integration with other stream processing pipelines.
- *
- * The stream processes text data and emits each line as a separate chunk, handling
- * lines that may span multiple input chunks automatically.
- *
  * @example
  * ```typescript
- * // Create a line-splitting stream
  * const lineStream = new TextLineTransformStream();
- *
- * // Pipe text through it
  * const lines = textStream.pipeThrough(lineStream);
- *
- * // Process each line
  * for await (const line of lines) {
  *   console.log('Line:', line);
  * }
  * ```
- *
- * @example
- * ```typescript
- * // Process SSE response line by line
- * const response = await fetch('/api/stream');
- * const lines = response.body!
- *   .pipeThrough(new TextDecoderStream())
- *   .pipeThrough(new TextLineTransformStream());
- *
- * for await (const line of lines) {
- *   if (line.startsWith('data: ')) {
- *     console.log('SSE data:', line.substring(6));
- *   }
- * }
- * ```
  */
 export declare class TextLineTransformStream extends TransformStream<string, string> {
-    /**
-     * Creates a new TextLineTransformStream instance.
-     *
-     * Initializes the stream with a TextLineTransformer that handles the line splitting logic.
-     */
     constructor();
 }
 //# sourceMappingURL=textLineTransformStream.d.ts.map

package/dist/textLineTransformStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"textLineTransformStream.d.ts","sourceRoot":"","sources":["../src/textLineTransformStream.ts"],"names":[],"mappings":"AA0CA,qBAAa,mBAAoB,YAAW,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC;IACrE,OAAO,CAAC,MAAM,CAAM;IAEpB;;;;;OAKG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC;IAetD;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC;CAU3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,uBAAwB,SAAQ,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC;IAC1E;;;;OAIG;;CAIJ"}
+{"version":3,"file":"textLineTransformStream.d.ts","sourceRoot":"","sources":["../src/textLineTransformStream.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;GAMG;AACH,qBAAa,mBAAoB,SAAQ,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC;IACtE,OAAO,CAAC,MAAM,CAAM;IAEpB,SAAS,CAAC,WAAW,CACnB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC,GACnD,IAAI;IAUP,SAAS,CAAC,OAAO,CACf,UAAU,EAAE,gCAAgC,CAAC,MAAM,CAAC,GACnD,IAAI;CAMR;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,uBAAwB,SAAQ,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC;;CAI3E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-eventstream",
-  "version": "3.16.6",
+  "version": "3.16.8",
   "description": "Server-Sent Events (SSE) support for Fetcher HTTP client with native LLM streaming API support. Enables real-time data streaming and token-by-token LLM response handling.",
   "keywords": [
     "fetch",