@ahoo-wang/fetcher-eventstream 1.0.6 → 1.1.0

package/dist/responses.d.ts

@@ -0,0 +1,77 @@
+import { ServerSentEventStream } from './eventStreamConverter';
+import { JsonServerSentEventStream } from './jsonServerSentEventTransformStream';
+declare global {
+    interface Response {
+        /**
+         * Gets the content type of the response.
+         *
+         * This property provides access to the Content-Type header of the response,
+         * which indicates the media type of the resource transmitted in the response.
+         *
+         * @returns The content type header value as a string, or null if the header is not set
+         */
+        get contentType(): string | null;
+        /**
+         * Checks if the response is an event stream.
+         *
+         * This property examines the Content-Type header to determine if the response
+         * contains server-sent events data (text/event-stream).
+         *
+         * @returns true if the response is an event stream, false otherwise
+         */
+        get isEventStream(): boolean;
+        /**
+         * Returns a ServerSentEventStream for consuming server-sent events.
+         *
+         * This method is added to Response objects by the EventStreamInterceptor
+         * when the response content type indicates a server-sent event stream.
+         *
+         * @returns A ReadableStream of ServerSentEvent objects, or null if not an event stream
+         */
+        eventStream(): ServerSentEventStream | null;
+        /**
+         * Returns a ServerSentEventStream for consuming server-sent events.
+         *
+         * This method is similar to eventStream() but will throw an error if the event stream is not available.
+         * It is added to Response objects by the EventStreamInterceptor when the response content type
+         * indicates a server-sent event stream.
+         *
+         * @returns A ReadableStream of ServerSentEvent objects
+         * @throws {Error} if the event stream is not available
+         */
+        requiredEventStream(): ServerSentEventStream;
+        /**
+         * Returns a JsonServerSentEventStream for consuming server-sent events with JSON data.
+         *
+         * This method is added to Response objects by the EventStreamInterceptor
+         * when the response content type indicates a server-sent event stream.
+         *
+         * @template DATA - The type of the JSON data in the server-sent events
+         * @returns A ReadableStream of ServerSentEvent objects with JSON data, or null if not an event stream
+         */
+        jsonEventStream<DATA>(): JsonServerSentEventStream<DATA> | null;
+        /**
+         * Returns a JsonServerSentEventStream for consuming server-sent events with JSON data.
+         *
+         * This method is similar to jsonEventStream() but will throw an error if the event stream is not available.
+         * It is added to Response objects by the EventStreamInterceptor when the response content type
+         * indicates a server-sent event stream with JSON data.
+         *
+         * @template DATA - The type of the JSON data in the server-sent events
+         * @returns A ReadableStream of ServerSentEvent objects with JSON data
+         * @throws {Error} if the event stream is not available
+         */
+        requiredJsonEventStream<DATA>(): JsonServerSentEventStream<DATA>;
+    }
+    interface ReadableStream<R = any> {
+        /**
+         * Makes ReadableStream async iterable for use with for-await loops.
+         *
+         * This allows the stream to be consumed using `for await (const chunk of stream)` syntax.
+         *
+         * @returns An async iterator for the stream
+         */
+        [Symbol.asyncIterator](): AsyncIterator<R>;
+    }
+}
+//# sourceMappingURL=responses.d.ts.map

package/dist/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../src/responses.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,qBAAqB,EAEtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,yBAAyB,EAE1B,MAAM,sCAAsC,CAAC;AAG9C,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;QAChB;;;;;;;WAOG;QACH,IAAI,WAAW,IAAI,MAAM,GAAG,IAAI,CAAC;QAEjC;;;;;;;WAOG;QACH,IAAI,aAAa,IAAI,OAAO,CAAC;QAE7B;;;;;;;WAOG;QACH,WAAW,IAAI,qBAAqB,GAAG,IAAI,CAAC;QAE5C;;;;;;;;;WASG;QACH,mBAAmB,IAAI,qBAAqB,CAAC;QAE7C;;;;;;;;WAQG;QACH,eAAe,CAAC,IAAI,KAAK,yBAAyB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAEhE;;;;;;;;;;WAUG;QACH,uBAAuB,CAAC,IAAI,KAAK,yBAAyB,CAAC,IAAI,CAAC,CAAC;KAClE;IAED,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;QAC9B;;;;;;WAMG;QACH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC;KAC5C;CACF"}

package/dist/serverSentEventTransformStream.d.ts

@@ -13,11 +13,11 @@ export interface ServerSentEvent {
     /** The reconnection interval (in milliseconds) to wait before retrying the connection */
     retry?: number;
 }
-export declare enum ServerSentEventField {
-    ID = "id",
-    RETRY = "retry",
-    EVENT = "event",
-    DATA = "data"
+export declare class ServerSentEventFields {
+    static readonly ID = "id";
+    static readonly RETRY = "retry";
+    static readonly EVENT = "event";
+    static readonly DATA = "data";
 }
 /**
  * Transformer responsible for converting a string stream into a ServerSentEvent object stream.

package/dist/serverSentEventTransformStream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serverSentEventTransformStream.d.ts","sourceRoot":"","sources":["../src/serverSentEventTransformStream.ts"],"names":[],"mappings":"AAaA;;;;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,oBAAY,oBAAoB;IAC9B,EAAE,OAAO;IACT,KAAK,UAAU;IACf,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AA6CD;;;;GAIG;AACH,qBAAa,0BACX,YAAW,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC;IAG/C,OAAO,CAAC,YAAY,CAKlB;IAEF;;;;;OAKG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC;IAiE/D;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC;CAwBpE;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,eAAe,CACjE,MAAM,EACN,eAAe,CAChB;;CAIA"}
+{"version":3,"file":"serverSentEventTransformStream.d.ts","sourceRoot":"","sources":["../src/serverSentEventTransformStream.ts"],"names":[],"mappings":"AAaA;;;;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,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;AA6CD;;;;GAIG;AACH,qBAAa,0BACX,YAAW,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC;IAE/C,OAAO,CAAC,YAAY,CAKlB;IAEF;;;;;OAKG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC;IAiE/D;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,gCAAgC,CAAC,eAAe,CAAC;CAwBpE;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,eAAe,CACjE,MAAM,EACN,eAAe,CAChB;;CAIA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-eventstream",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "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",
@@ -39,7 +39,7 @@
     "dist"
   ],
   "dependencies": {
-    "@ahoo-wang/fetcher": "1.0.6"
+    "@ahoo-wang/fetcher": "1.1.0"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^3.2.4",

package/dist/eventStreamInterceptor.d.ts

@@ -1,62 +0,0 @@
-import { FetchExchange, ResponseInterceptor } from '@ahoo-wang/fetcher';
-/**
- * The name of the EventStreamInterceptor.
- */
-export declare const EVENT_STREAM_INTERCEPTOR_NAME = "EventStreamInterceptor";
-/**
- * The order of the EventStreamInterceptor.
- * Set to Number.MAX_SAFE_INTEGER - 1000 to ensure it runs latest among response interceptors.
- */
-export declare const EVENT_STREAM_INTERCEPTOR_ORDER: number;
-/**
- * Interceptor that enhances Response objects with event stream capabilities.
- *
- * This interceptor detects responses with `text/event-stream` content type and adds
- * an `eventStream()` method to the Response object, which returns a readable stream
- * of Server-Sent Events that can be consumed using `for await` syntax.
- *
- * @remarks
- * This interceptor runs at the very end of the response interceptor chain to ensure
- * it runs after all standard response processing is complete, as it adds
- * specialized functionality to the response object. The order is set to
- * EVENT_STREAM_INTERCEPTOR_ORDER to ensure it executes latest among response interceptors,
- * allowing for other response interceptors to run before it if needed. This positioning
- * ensures that all response processing is completed before specialized event stream
- * functionality is added to the response object.
- *
- * @example
- * ```typescript
- * // Using the eventStream method
- * const response = await fetcher.get('/events');
- * if (response.headers.get('content-type')?.includes('text/event-stream')) {
- *   const eventStream = response.eventStream();
- *   for await (const event of eventStream) {
- *     console.log('Received event:', event);
- *   }
- * }
- * ```
- */
-export declare class EventStreamInterceptor implements ResponseInterceptor {
-    readonly name = "EventStreamInterceptor";
-    readonly order: number;
-    /**
-     * Intercepts responses to add event stream capabilities.
-     *
-     * This method runs at the very end of the response interceptor chain to ensure
-     * it runs after all standard response processing is complete. It detects responses
-     * with `text/event-stream` content type and adds an `eventStream()` method to
-     * the Response object, which returns a readable stream of Server-Sent Events.
-     *
-     * @param exchange - The exchange containing the response to enhance
-     *
-     * @remarks
-     * This method executes latest among response interceptors to ensure all response
-     * processing is completed before specialized event stream functionality is added.
-     * It only enhances responses with `text/event-stream` content type, leaving other
-     * responses unchanged. The positioning at the end of the response chain ensures
-     * that all response transformations and validations are completed before event
-     * stream capabilities are added to the response object.
-     */
-    intercept(exchange: FetchExchange): void;
-}
-//# sourceMappingURL=eventStreamInterceptor.d.ts.map

package/dist/eventStreamInterceptor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"eventStreamInterceptor.d.ts","sourceRoot":"","sources":["../src/eventStreamInterceptor.ts"],"names":[],"mappings":"AAcA,OAAO,EAGL,aAAa,EACb,mBAAmB,EACpB,MAAM,oBAAoB,CAAC;AAG5B;;GAEG;AACH,eAAO,MAAM,6BAA6B,2BAA2B,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,8BAA8B,QAAiC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,sBAAuB,YAAW,mBAAmB;IAChE,QAAQ,CAAC,IAAI,4BAAiC;IAC9C,QAAQ,CAAC,KAAK,SAAkC;IAEhD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,QAAQ,EAAE,aAAa;CAalC"}

package/dist/types.d.ts

@@ -1,32 +0,0 @@
-import { ServerSentEventStream } from './eventStreamConverter';
-import { JsonServerSentEventStream } from './jsonServerSentEventTransformStream';
-declare global {
-    interface Response {
-        /**
-         * Returns a ServerSentEventStream for consuming server-sent events.
-         *
-         * This method is added to Response objects by the EventStreamInterceptor
-         * when the response content type indicates a server-sent event stream.
-         *
-         * @returns A ReadableStream of ServerSentEvent objects
-         */
-        eventStream?(): ServerSentEventStream;
-        /**
-         * Returns a JsonServerSentEventStream for consuming server-sent events with JSON data.
-         *
-         * This method is added to Response objects by the EventStreamInterceptor
-         * when the response content type indicates a server-sent event stream.
-         *
-         * @template DATA - The type of the JSON data in the server-sent events
-         * @returns A ReadableStream of ServerSentEvent objects with JSON data
-         */
-        jsonEventStream?<DATA>(): JsonServerSentEventStream<DATA>;
-    }
-    interface ReadableStream<R = any> {
-        /**
-         * Makes ReadableStream async iterable for use with for-await loops.
-         */
-        [Symbol.asyncIterator](): AsyncIterator<R>;
-    }
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;QAChB;;;;;;;WAOG;QACH,WAAW,CAAC,IAAI,qBAAqB,CAAC;QAEtC;;;;;;;;WAQG;QACH,eAAe,CAAC,CAAC,IAAI,KAAK,yBAAyB,CAAC,IAAI,CAAC,CAAC;KAC3D;IAED,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;QAC9B;;WAEG;QACH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC;KAC5C;CACF"}