light-sse 1.0.0

package/README.md

@@ -0,0 +1,108 @@
+# EventSource2
+
+A lightweight Server-Sent Events (SSE) client library built with TypeScript. Unlike the native `EventSource` API, this library supports custom headers, making it ideal for authenticated SSE connections.
+
+## Installation
+
+```bash
+npm install
+npm run build
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { EventSource2 } from "./eventsource2";
+
+const eventSource = await EventSource2.new("https://api.example.com/stream", {
+  onmessage: (payload) => {
+    console.log("Received:", payload);
+  },
+  onerror: (error) => {
+    console.error("Error:", error);
+  },
+});
+
+// When done, close the connection
+eventSource.close();
+```
+
+### With Custom Headers
+
+```typescript
+import { EventSource2 } from "./eventsource2";
+
+const eventSource = await EventSource2.new(
+  "https://api.example.com/stream",
+  {
+    onmessage: (payload) => {
+      console.log("Received:", payload);
+    },
+    onerror: (error) => {
+      console.error("Error:", error);
+    },
+  },
+  {
+    Authorization: "Bearer your-token-here",
+    "X-Custom-Header": "custom-value",
+  }
+);
+
+eventSource.close();
+```
+
+## API
+
+### `EventSource2.new(url, callbacks, headers?)`
+
+Creates a new SSE connection.
+
+**Parameters:**
+
+| Parameter   | Type                              | Required | Description                              |
+|-------------|-----------------------------------|----------|------------------------------------------|
+| `url`       | `string`                          | Yes      | The SSE endpoint URL                     |
+| `callbacks` | `{ onmessage, onerror? }`         | Yes      | Event handlers                           |
+| `headers`   | `HeadersInit`                     | No       | Custom headers for the request           |
+
+**Callbacks:**
+
+- `onmessage(payload: string)`: Called when a message is received. Returns the parsed data content.
+- `onerror(error: any)`: Called when an error occurs (optional).
+
+### `eventSource.close()`
+
+Closes the SSE connection and cancels the underlying reader.
+
+## How It Works
+
+1. **Connection**: Uses the Fetch API with `Accept: text/event-stream` header
+2. **Reading**: Utilizes `ReadableStream` to read chunks from the response body
+3. **Parsing**: Detects SSE message boundaries (`\n\n` or `\r\n\r\n`) and extracts `data:` fields
+4. **Decoding**: Uses `TextDecoder` to convert binary chunks to strings
+
+## SSE Format
+
+The library expects the standard SSE format:
+
+```
+data: Message 1
+
+data: Message 2
+
+data: Message 3
+```
+
+Multiple `data:` lines within the same block are joined with newlines.
+
+## Browser Support
+
+Requires browsers that support:
+- [Fetch API](https://caniuse.com/fetch)
+- [ReadableStream](https://caniuse.com/streams)
+
+## License
+
+MIT

package/dist/eventsource2.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventSource2 = void 0;
+class EventSource2 {
+    reader;
+    decoder = new TextDecoder();
+    buffer = "";
+    onmessage;
+    onerror;
+    static async new(url, callbacks, headers) {
+        const event = new EventSource2();
+        await event._init(url, headers);
+        event.onmessage = callbacks.onmessage;
+        if (callbacks.onerror)
+            event.onerror = callbacks.onerror;
+        event.startReading();
+        return event;
+    }
+    async _init(url, headers = {}) {
+        const response = await fetch(url, {
+            method: 'GET',
+            headers: {
+                ...headers,
+                "Accept": "text/event-stream",
+            }
+        });
+        if (!response.ok) {
+            throw new Error(`Failed to connect to EventSource: ${response.status} ${response.statusText}`);
+        }
+        this.reader = response.body?.getReader();
+    }
+    async startReading() {
+        if (!this.reader)
+            return;
+        while (true) {
+            try {
+                const { value, done } = await this.reader.read();
+                if (done)
+                    break;
+                this.buffer += this.decoder.decode(value, { stream: true });
+                let boundary = this.buffer.indexOf('\n\n');
+                while (boundary !== -1) {
+                    const messageBlock = this.buffer.substring(0, boundary).trim();
+                    this.buffer = this.buffer.substring(boundary + 2);
+                    if (this.onmessage && messageBlock) {
+                        const cleanMessage = this.parseSSE(messageBlock);
+                        if (cleanMessage) {
+                            this.onmessage(cleanMessage);
+                        }
+                    }
+                    boundary = this.buffer.indexOf('\n\n');
+                }
+            }
+            catch (error) {
+                if (error?.name === 'AbortError')
+                    break;
+                if (this.onerror)
+                    this.onerror(error);
+                break;
+            }
+        }
+    }
+    parseSSE(block) {
+        return block
+            .split('\n')
+            .filter(line => line.startsWith('data:'))
+            .map(line => line.replace(/^data:\s?/, ''))
+            .join('\n');
+    }
+    close() {
+        if (this.reader) {
+            this.reader.cancel().catch(() => { });
+            this.reader = undefined;
+        }
+    }
+}
+exports.EventSource2 = EventSource2;

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "light-sse",
+  "version": "1.0.0",
+  "main": "dist/main.js",
+  "description": "Tu descripción",
+  "author": "Tu nombre",
+  "license": "MIT",
+  "keywords": ["eventsource", "sse"],
+  "files": ["dist/"],
+  "scripts": {
+    "build": "tsc"
+  }
+}