hx-stream 0.0.3 → 0.0.6

package/dist/server.js

@@ -0,0 +1,94 @@
+const encoder = new TextEncoder();
+const headers = {
+    // Chunked encoding with immediate forwarding by proxies (i.e. nginx)
+    "X-Accel-Buffering": "no",
+    "Transfer-Encoding": "chunked",
+    "Content-Type": "text/html",
+    // the maximum keep alive chrome shouldn't ignore
+    "Keep-Alive": "timeout=60",
+    "Connection": "keep-alive",
+};
+export class StreamResponse {
+    #controller;
+    #timer;
+    #state;
+    #render;
+    response;
+    // just to make it polyfill
+    withCredentials;
+    url;
+    get readyState() { return this.#state; }
+    static CONNECTING = 0;
+    static OPEN = 1;
+    static CLOSED = 2;
+    constructor(request, options) {
+        this.#controller = null;
+        this.#state = StreamResponse.CONNECTING;
+        this.#render = options.render;
+        this.withCredentials = request.mode === "cors";
+        this.url = request.url;
+        // immediate prepare for abortion
+        const cancel = () => { this.close(); };
+        request.signal.addEventListener('abort', cancel);
+        const start = (c) => { this.#controller = c; this.#state = StreamResponse.OPEN; };
+        const stream = new ReadableStream({ start, cancel }, { highWaterMark: 0 });
+        this.response = new Response(stream, { headers });
+        this.#timer = setInterval(() => this.keepAlive(), options.keepAlive || 30_000);
+    }
+    bind(controller) {
+        this.#controller = controller;
+    }
+    sendBytes(chunk) {
+        if (!this.#controller)
+            return false;
+        try {
+            this.#controller.enqueue(chunk);
+            return true;
+        }
+        catch (e) {
+            console.error(e);
+            this.close(); // unbind on failure
+            return false;
+        }
+    }
+    sendText(chunk) {
+        return this.sendBytes(encoder.encode(chunk));
+    }
+    keepAlive() { return this.sendText(" "); }
+    send(target, swap, html) {
+        if (this.#state === StreamResponse.CLOSED) {
+            const err = new Error(`Warn: Attempted to send data on closed stream for: ${this.url}`);
+            console.warn(err);
+        }
+        if (typeof html !== "string") {
+            if (!this.#render)
+                throw new Error(`Cannot render to JSX when no renderer provided during class initialization`);
+            html = this.#render(html);
+        }
+        return this.sendText(`<div hx-swap-oob="${swap}:${target}">${html}</div>`);
+    }
+    close() {
+        if (this.#state === StreamResponse.CLOSED) {
+            this.#controller = null;
+            return false;
+        }
+        if (this.#controller) {
+            try {
+                this.#controller.close();
+            }
+            catch (e) {
+                console.error(e);
+            }
+            this.#controller = null;
+        }
+        // Cleanup
+        if (this.#timer)
+            clearInterval(this.#timer);
+        // Mark closed
+        this.#state = StreamResponse.CLOSED;
+        return true;
+    }
+}
+export function MakeStream(request, options) {
+    return new StreamResponse(request, options);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hx-stream",
-	"version": "0.0.3",
+	"version": "0.0.6",
 	"description": "keep htmx client state across page refreshes",
 	"keywords": [ "htmx", "streaming" ],
 	"homepage": "https://hx-stream.ajanibilby.com",
@@ -20,7 +20,7 @@
 	},
 	"license": "MIT",
 	"author": "Ajani Bilby",
-	"type": "commonjs",
+	"type": "module",
 	"main": "dist/client.min.js",
 	"devDependencies": {
 		"terser": "^5.39.0",