@flink-app/streaming-plugin 0.12.1-alpha.45

package/dist/StreamingPlugin.js

@@ -0,0 +1,276 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamingPlugin = void 0;
+exports.streamingPlugin = streamingPlugin;
+var flink_1 = require("@flink-app/flink");
+/**
+ * Creates a stream writer for the given format
+ */
+function createStreamWriter(res, format, debug) {
+    var closed = false;
+    res.on("close", function () {
+        closed = true;
+        if (debug) {
+            flink_1.log.debug("[StreamingPlugin] Client closed connection");
+        }
+    });
+    return {
+        write: function (data) {
+            if (closed) {
+                if (debug) {
+                    flink_1.log.warn("[StreamingPlugin] Attempted write to closed stream");
+                }
+                return;
+            }
+            try {
+                if (format === "sse") {
+                    // SSE format: data: {json}\n\n
+                    res.write("data: ".concat(JSON.stringify(data), "\n\n"));
+                }
+                else if (format === "ndjson") {
+                    // NDJSON format: {json}\n
+                    res.write("".concat(JSON.stringify(data), "\n"));
+                }
+            }
+            catch (err) {
+                flink_1.log.error("[StreamingPlugin] Error writing to stream:", err);
+                closed = true;
+            }
+        },
+        error: function (error) {
+            if (closed)
+                return;
+            var errorMessage = typeof error === "string" ? error : error.message;
+            try {
+                if (format === "sse") {
+                    // SSE error event
+                    res.write("event: error\ndata: ".concat(JSON.stringify({ message: errorMessage }), "\n\n"));
+                }
+                else if (format === "ndjson") {
+                    // NDJSON error object
+                    res.write("".concat(JSON.stringify({ error: errorMessage }), "\n"));
+                }
+            }
+            catch (err) {
+                flink_1.log.error("[StreamingPlugin] Error writing error to stream:", err);
+                closed = true;
+            }
+        },
+        end: function () {
+            if (closed)
+                return;
+            closed = true;
+            res.end();
+        },
+        isOpen: function () {
+            return !closed;
+        },
+    };
+}
+/**
+ * Streaming plugin for Flink Framework
+ * Provides SSE and NDJSON streaming support
+ */
+var StreamingPlugin = /** @class */ (function () {
+    function StreamingPlugin(options) {
+        if (options === void 0) { options = {}; }
+        this.id = "streaming";
+        this.options = {
+            defaultFormat: options.defaultFormat || "sse",
+            debug: options.debug || false,
+        };
+    }
+    StreamingPlugin.prototype.init = function (app) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.app = app;
+                if (this.options.debug) {
+                    flink_1.log.info("[StreamingPlugin] Initialized with default format: ".concat(this.options.defaultFormat));
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    // Implementation
+    StreamingPlugin.prototype.registerStreamHandler = function (handlerOrModule, routeProps) {
+        var _this = this;
+        if (!this.app) {
+            throw new Error("[StreamingPlugin] Plugin not initialized - call app.start() first");
+        }
+        if (!this.app.expressApp) {
+            throw new Error("[StreamingPlugin] Express app not available");
+        }
+        // Determine if we received a module or explicit handler+props
+        var handler;
+        var props;
+        if (typeof handlerOrModule === "function") {
+            // Explicit handler function + route props
+            if (!routeProps) {
+                throw new Error("[StreamingPlugin] Route props are required when registering with explicit handler function");
+            }
+            handler = handlerOrModule;
+            props = routeProps;
+        }
+        else {
+            // Handler module with default export and Route
+            var module_1 = handlerOrModule;
+            if (!module_1.default) {
+                throw new Error("[StreamingPlugin] Handler module must have a default export");
+            }
+            if (!module_1.Route) {
+                throw new Error("[StreamingPlugin] Handler module must export Route configuration");
+            }
+            handler = module_1.default;
+            props = module_1.Route;
+        }
+        var method = props.method || flink_1.HttpMethod.get;
+        var format = props.format || this.options.defaultFormat;
+        var methodAndRoute = "".concat(method.toUpperCase(), " ").concat(props.path);
+        // Register Express route
+        this.app.expressApp[method](props.path, function (req, res) { return __awaiter(_this, void 0, void 0, function () {
+            var authenticated, err_1, streamWriter, err_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!props.permissions) return [3 /*break*/, 4];
+                        if (!this.app.auth) {
+                            flink_1.log.error("[StreamingPlugin] ".concat(methodAndRoute, " requires authentication but no auth plugin is configured"));
+                            res.status(500).json({
+                                status: 500,
+                                error: {
+                                    title: "Internal Server Error",
+                                    detail: "Authentication not configured",
+                                },
+                            });
+                            return [2 /*return*/];
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.app.auth.authenticateRequest(req, props.permissions)];
+                    case 2:
+                        authenticated = _a.sent();
+                        if (!authenticated) {
+                            res.status(401).json({
+                                status: 401,
+                                error: {
+                                    title: "Unauthorized",
+                                    detail: "Authentication required",
+                                },
+                            });
+                            return [2 /*return*/];
+                        }
+                        return [3 /*break*/, 4];
+                    case 3:
+                        err_1 = _a.sent();
+                        flink_1.log.error("[StreamingPlugin] ".concat(methodAndRoute, " authentication error:"), err_1);
+                        res.status(401).json({
+                            status: 401,
+                            error: {
+                                title: "Unauthorized",
+                                detail: "Authentication failed",
+                            },
+                        });
+                        return [2 /*return*/];
+                    case 4:
+                        // Set headers based on format
+                        if (format === "sse") {
+                            res.setHeader("Content-Type", "text/event-stream");
+                            res.setHeader("Cache-Control", "no-cache");
+                            res.setHeader("Connection", "keep-alive");
+                            res.setHeader("X-Accel-Buffering", "no"); // Disable nginx buffering
+                        }
+                        else if (format === "ndjson") {
+                            res.setHeader("Content-Type", "application/x-ndjson");
+                            res.setHeader("Cache-Control", "no-cache");
+                            res.setHeader("X-Accel-Buffering", "no");
+                        }
+                        // Flush headers immediately
+                        res.flushHeaders();
+                        streamWriter = createStreamWriter(res, format, this.options.debug);
+                        _a.label = 5;
+                    case 5:
+                        _a.trys.push([5, 7, 8, 9]);
+                        if (this.options.debug) {
+                            flink_1.log.debug("[StreamingPlugin] ".concat(methodAndRoute, " - Stream started"));
+                        }
+                        // Call the handler
+                        return [4 /*yield*/, handler({
+                                req: req,
+                                ctx: this.app.ctx,
+                                stream: streamWriter,
+                                origin: props.origin,
+                            })];
+                    case 6:
+                        // Call the handler
+                        _a.sent();
+                        if (this.options.debug) {
+                            flink_1.log.debug("[StreamingPlugin] ".concat(methodAndRoute, " - Handler completed"));
+                        }
+                        return [3 /*break*/, 9];
+                    case 7:
+                        err_2 = _a.sent();
+                        flink_1.log.error("[StreamingPlugin] ".concat(methodAndRoute, " - Handler error:"), err_2);
+                        // Send error to client if stream still open
+                        if (streamWriter.isOpen()) {
+                            streamWriter.error(err_2);
+                        }
+                        return [3 /*break*/, 9];
+                    case 8:
+                        // Ensure stream is closed
+                        if (streamWriter.isOpen()) {
+                            streamWriter.end();
+                        }
+                        return [7 /*endfinally*/];
+                    case 9: return [2 /*return*/];
+                }
+            });
+        }); });
+        flink_1.log.info("[StreamingPlugin] Registered streaming route ".concat(methodAndRoute, " (").concat(format, ")"));
+    };
+    return StreamingPlugin;
+}());
+exports.StreamingPlugin = StreamingPlugin;
+/**
+ * Factory function to create streaming plugin
+ */
+function streamingPlugin(options) {
+    return new StreamingPlugin(options);
+}
+//# sourceMappingURL=StreamingPlugin.js.map

package/dist/StreamingPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamingPlugin.js","sourceRoot":"","sources":["../src/StreamingPlugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsRA,0CAEC;AAvRD,0CAAwF;AAUxF;;GAEG;AACH,SAAS,kBAAkB,CACvB,GAAa,EACb,MAAoB,EACpB,KAAc;IAEd,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE;QACZ,MAAM,GAAG,IAAI,CAAC;QACd,IAAI,KAAK,EAAE,CAAC;YACR,WAAG,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO;QACH,KAAK,YAAC,IAAO;YACT,IAAI,MAAM,EAAE,CAAC;gBACT,IAAI,KAAK,EAAE,CAAC;oBACR,WAAG,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;gBACnE,CAAC;gBACD,OAAO;YACX,CAAC;YAED,IAAI,CAAC;gBACD,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;oBACnB,+BAA+B;oBAC/B,GAAG,CAAC,KAAK,CAAC,gBAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAM,CAAC,CAAC;gBACnD,CAAC;qBAAM,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;oBAC7B,0BAA0B;oBAC1B,GAAG,CAAC,KAAK,CAAC,UAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAI,CAAC,CAAC;gBAC3C,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,WAAG,CAAC,KAAK,CAAC,4CAA4C,EAAE,GAAG,CAAC,CAAC;gBAC7D,MAAM,GAAG,IAAI,CAAC;YAClB,CAAC;QACL,CAAC;QAED,KAAK,YAAC,KAAqB;YACvB,IAAI,MAAM;gBAAE,OAAO;YAEnB,IAAM,YAAY,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;YAEvE,IAAI,CAAC;gBACD,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;oBACnB,kBAAkB;oBAClB,GAAG,CAAC,KAAK,CAAC,8BAAuB,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,SAAM,CAAC,CAAC;gBACtF,CAAC;qBAAM,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;oBAC7B,sBAAsB;oBACtB,GAAG,CAAC,KAAK,CAAC,UAAG,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,OAAI,CAAC,CAAC;gBAC9D,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,WAAG,CAAC,KAAK,CAAC,kDAAkD,EAAE,GAAG,CAAC,CAAC;gBACnE,MAAM,GAAG,IAAI,CAAC;YAClB,CAAC;QACL,CAAC;QAED,GAAG;YACC,IAAI,MAAM;gBAAE,OAAO;YACnB,MAAM,GAAG,IAAI,CAAC;YACd,GAAG,CAAC,GAAG,EAAE,CAAC;QACd,CAAC;QAED,MAAM;YACF,OAAO,CAAC,MAAM,CAAC;QACnB,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;GAGG;AACH;IAKI,yBAAY,OAAoC;QAApC,wBAAA,EAAA,YAAoC;QAJzC,OAAE,GAAG,WAAW,CAAC;QAKpB,IAAI,CAAC,OAAO,GAAG;YACX,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,KAAK;YAC7C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK;SAChC,CAAC;IACN,CAAC;IAEK,8BAAI,GAAV,UAAW,GAAkB;;;gBACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;gBAEf,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACrB,WAAG,CAAC,IAAI,CAAC,6DAAsD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAE,CAAC,CAAC;gBACjG,CAAC;;;;KACJ;IAoCD,iBAAiB;IACV,+CAAqB,GAA5B,UACI,eAAoE,EACpE,UAAgC;QAFpC,iBAmIC;QA/HG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACzF,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACnE,CAAC;QAED,8DAA8D;QAC9D,IAAI,OAA8B,CAAC;QACnC,IAAI,KAA0B,CAAC;QAE/B,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE,CAAC;YACxC,0CAA0C;YAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,4FAA4F,CAAC,CAAC;YAClH,CAAC;YACD,OAAO,GAAG,eAAe,CAAC;YAC1B,KAAK,GAAG,UAAU,CAAC;QACvB,CAAC;aAAM,CAAC;YACJ,+CAA+C;YAC/C,IAAM,QAAM,GAAG,eAA8C,CAAC;YAC9D,IAAI,CAAC,QAAM,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;YACnF,CAAC;YACD,IAAI,CAAC,QAAM,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACxF,CAAC;YACD,OAAO,GAAG,QAAM,CAAC,OAAO,CAAC;YACzB,KAAK,GAAG,QAAM,CAAC,KAAK,CAAC;QACzB,CAAC;QAED,IAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,kBAAU,CAAC,GAAG,CAAC;QAC9C,IAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;QAC1D,IAAM,cAAc,GAAG,UAAG,MAAM,CAAC,WAAW,EAAE,cAAI,KAAK,CAAC,IAAI,CAAE,CAAC;QAE/D,yBAAyB;QACzB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,UAAO,GAAQ,EAAE,GAAQ;;;;;6BAEzD,KAAK,CAAC,WAAW,EAAjB,wBAAiB;wBACjB,IAAI,CAAC,IAAI,CAAC,GAAI,CAAC,IAAI,EAAE,CAAC;4BAClB,WAAG,CAAC,KAAK,CAAC,4BAAqB,cAAc,8DAA2D,CAAC,CAAC;4BAC1G,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gCACjB,MAAM,EAAE,GAAG;gCACX,KAAK,EAAE;oCACH,KAAK,EAAE,uBAAuB;oCAC9B,MAAM,EAAE,+BAA+B;iCAC1C;6BACJ,CAAC,CAAC;4BACH,sBAAO;wBACX,CAAC;;;;wBAGyB,qBAAM,IAAI,CAAC,GAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAU,EAAE,KAAK,CAAC,WAAW,CAAC,EAAA;;wBAAvF,aAAa,GAAG,SAAuE;wBAC7F,IAAI,CAAC,aAAa,EAAE,CAAC;4BACjB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gCACjB,MAAM,EAAE,GAAG;gCACX,KAAK,EAAE;oCACH,KAAK,EAAE,cAAc;oCACrB,MAAM,EAAE,yBAAyB;iCACpC;6BACJ,CAAC,CAAC;4BACH,sBAAO;wBACX,CAAC;;;;wBAED,WAAG,CAAC,KAAK,CAAC,4BAAqB,cAAc,2BAAwB,EAAE,KAAG,CAAC,CAAC;wBAC5E,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;4BACjB,MAAM,EAAE,GAAG;4BACX,KAAK,EAAE;gCACH,KAAK,EAAE,cAAc;gCACrB,MAAM,EAAE,uBAAuB;6BAClC;yBACJ,CAAC,CAAC;wBACH,sBAAO;;wBAIf,8BAA8B;wBAC9B,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;4BACnB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;4BACnD,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;4BAC3C,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;4BAC1C,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC,0BAA0B;wBACxE,CAAC;6BAAM,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;4BAC7B,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;4BACtD,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;4BAC3C,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;wBAC7C,CAAC;wBAED,4BAA4B;wBAC5B,GAAG,CAAC,YAAY,EAAE,CAAC;wBAGb,YAAY,GAAG,kBAAkB,CAAI,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;;;;wBAGxE,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;4BACrB,WAAG,CAAC,KAAK,CAAC,4BAAqB,cAAc,sBAAmB,CAAC,CAAC;wBACtE,CAAC;wBAED,mBAAmB;wBACnB,qBAAM,OAAO,CAAC;gCACV,GAAG,EAAE,GAAU;gCACf,GAAG,EAAE,IAAI,CAAC,GAAI,CAAC,GAAG;gCAClB,MAAM,EAAE,YAAY;gCACpB,MAAM,EAAE,KAAK,CAAC,MAAM;6BACvB,CAAC,EAAA;;wBANF,mBAAmB;wBACnB,SAKE,CAAC;wBAEH,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;4BACrB,WAAG,CAAC,KAAK,CAAC,4BAAqB,cAAc,yBAAsB,CAAC,CAAC;wBACzE,CAAC;;;;wBAED,WAAG,CAAC,KAAK,CAAC,4BAAqB,cAAc,sBAAmB,EAAE,KAAG,CAAC,CAAC;wBAEvE,4CAA4C;wBAC5C,IAAI,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC;4BACxB,YAAY,CAAC,KAAK,CAAC,KAAY,CAAC,CAAC;wBACrC,CAAC;;;wBAED,0BAA0B;wBAC1B,IAAI,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC;4BACxB,YAAY,CAAC,GAAG,EAAE,CAAC;wBACvB,CAAC;;;;;aAER,CAAC,CAAC;QAEH,WAAG,CAAC,IAAI,CAAC,uDAAgD,cAAc,eAAK,MAAM,MAAG,CAAC,CAAC;IAC3F,CAAC;IACL,sBAAC;AAAD,CAAC,AA3LD,IA2LC;AA3LY,0CAAe;AA6L5B;;GAEG;AACH,SAAgB,eAAe,CAAC,OAAgC;IAC5D,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { StreamingPlugin, streamingPlugin } from "./StreamingPlugin";
+export type { StreamFormat, StreamWriter, StreamHandlerProps, StreamHandler, StreamHandlerModule, StreamingRouteProps, StreamingPluginOptions, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGrE,YAAY,EACR,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,GACzB,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamingPlugin = exports.StreamingPlugin = void 0;
+// Main plugin export
+var StreamingPlugin_1 = require("./StreamingPlugin");
+Object.defineProperty(exports, "StreamingPlugin", { enumerable: true, get: function () { return StreamingPlugin_1.StreamingPlugin; } });
+Object.defineProperty(exports, "streamingPlugin", { enumerable: true, get: function () { return StreamingPlugin_1.streamingPlugin; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qBAAqB;AACrB,qDAAqE;AAA5D,kHAAA,eAAe,OAAA;AAAE,kHAAA,eAAe,OAAA"}

package/dist/types.d.ts

@@ -0,0 +1,86 @@
+import { FlinkContext, FlinkRequest, RouteProps, HttpMethod } from "@flink-app/flink";
+/**
+ * Streaming format types
+ */
+export type StreamFormat = "sse" | "ndjson";
+/**
+ * Stream writer interface for sending data to clients
+ */
+export interface StreamWriter<T = any> {
+    /**
+     * Write data to the stream
+     */
+    write(data: T): void;
+    /**
+     * Send an error event to the stream
+     */
+    error(error: Error | string): void;
+    /**
+     * End the stream
+     */
+    end(): void;
+    /**
+     * Check if the connection is still open
+     */
+    isOpen(): boolean;
+}
+/**
+ * Props passed to streaming handlers
+ */
+export interface StreamHandlerProps<Ctx extends FlinkContext, T = any> {
+    req: FlinkRequest;
+    ctx: Ctx;
+    stream: StreamWriter<T>;
+    origin?: string;
+}
+/**
+ * Streaming handler function signature
+ */
+export type StreamHandler<Ctx extends FlinkContext, T = any> = (props: StreamHandlerProps<Ctx, T>) => Promise<void> | void;
+/**
+ * Route configuration for streaming endpoints
+ */
+export interface StreamingRouteProps extends Omit<RouteProps, "skipAutoRegister"> {
+    /**
+     * HTTP path for the streaming endpoint
+     */
+    path: string;
+    /**
+     * HTTP method (defaults to GET)
+     */
+    method?: HttpMethod;
+    /**
+     * Streaming format to use
+     * - 'sse': Server-Sent Events (text/event-stream)
+     * - 'ndjson': Newline-Delimited JSON (application/x-ndjson)
+     * @default 'sse'
+     */
+    format?: StreamFormat;
+    /**
+     * Must be true for streaming handlers (prevents auto-registration)
+     */
+    skipAutoRegister: true;
+}
+/**
+ * Options for creating the streaming plugin
+ */
+export interface StreamingPluginOptions {
+    /**
+     * Default format if not specified in route props
+     * @default 'sse'
+     */
+    defaultFormat?: StreamFormat;
+    /**
+     * Enable debug logging
+     * @default false
+     */
+    debug?: boolean;
+}
+/**
+ * Handler module type (namespace import with default export and Route)
+ */
+export interface StreamHandlerModule<Ctx extends FlinkContext = any, T = any> {
+    default: StreamHandler<Ctx, T>;
+    Route: StreamingRouteProps;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEtF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,GAAG;IACjC;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,GAAG,IAAI,IAAI,CAAC;IAEZ;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,GAAG,SAAS,YAAY,EAAE,CAAC,GAAG,GAAG;IACjE,GAAG,EAAE,YAAY,CAAC;IAClB,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,GAAG,SAAS,YAAY,EAAE,CAAC,GAAG,GAAG,IAAI,CAC3D,KAAK,EAAE,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC,KAChC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAC7E;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,gBAAgB,EAAE,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;OAGG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,GAAG,SAAS,YAAY,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;IACxE,OAAO,EAAE,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC/B,KAAK,EAAE,mBAAmB,CAAC;CAC9B"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/examples/authenticated-stream.ts

@@ -0,0 +1,88 @@
+/**
+ * Example: Authenticated Streaming Handler
+ *
+ * This example shows how to use authentication with streaming handlers.
+ * Works with any Flink auth plugin (JWT, BankID, OAuth, etc.)
+ */
+
+import { StreamHandler, StreamingRouteProps } from "@flink-app/streaming-plugin";
+import { FlinkContext } from "@flink-app/flink";
+
+// Route configuration with permissions
+export const Route: StreamingRouteProps = {
+    path: "/admin/live-metrics",
+    format: "sse",
+    skipAutoRegister: true,
+    permissions: ["admin"], // Only users with 'admin' role can access
+};
+
+interface MetricEvent {
+    metric: string;
+    value: number;
+    timestamp: number;
+    userId: string;
+}
+
+/**
+ * Authenticated streaming handler
+ * Only accessible to users with 'admin' permission
+ */
+const GetLiveMetrics: StreamHandler<FlinkContext, MetricEvent> = async ({ req, stream }) => {
+    // req.user is populated by the auth plugin after successful authentication
+    const userId = (req as any).user?.userId || "unknown";
+
+    console.log(`Admin user ${userId} connected to live metrics stream`);
+
+    let count = 0;
+    const maxMetrics = 20;
+
+    // Stream metrics every second
+    const interval = setInterval(() => {
+        if (!stream.isOpen() || count >= maxMetrics) {
+            clearInterval(interval);
+            stream.end();
+            console.log(`User ${userId} disconnected from metrics stream`);
+            return;
+        }
+
+        // Send metric with user context
+        stream.write({
+            metric: "cpu_usage",
+            value: Math.random() * 100,
+            timestamp: Date.now(),
+            userId,
+        });
+
+        count++;
+    }, 1000);
+};
+
+export default GetLiveMetrics;
+
+/**
+ * CLIENT USAGE:
+ *
+ * ```typescript
+ * // Must include authentication header (depends on your auth plugin)
+ * const eventSource = new EventSource('/admin/live-metrics', {
+ *     headers: {
+ *         'Authorization': 'Bearer your-jwt-token'
+ *     }
+ * });
+ *
+ * eventSource.onmessage = (event) => {
+ *     const metric = JSON.parse(event.data);
+ *     console.log(`Metric from user ${metric.userId}:`, metric);
+ * };
+ *
+ * eventSource.onerror = (error) => {
+ *     console.error('Authentication failed or connection lost');
+ * };
+ * ```
+ *
+ * Note: EventSource API doesn't support custom headers in browsers.
+ * For authenticated SSE, you may need to:
+ * 1. Pass token as query parameter: `/admin/live-metrics?token=...`
+ * 2. Use cookie-based authentication
+ * 3. Use Fetch API with ReadableStream instead of EventSource
+ */

package/examples/client-ndjson.html

@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>NDJSON Streaming Example</title>
+    <style>
+        body {
+            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+            max-width: 800px;
+            margin: 50px auto;
+            padding: 20px;
+        }
+        #output {
+            background: #f5f5f5;
+            padding: 20px;
+            border-radius: 8px;
+            min-height: 200px;
+            white-space: pre-wrap;
+            font-family: 'Monaco', monospace;
+            font-size: 14px;
+        }
+        button {
+            background: #007bff;
+            color: white;
+            border: none;
+            padding: 10px 20px;
+            border-radius: 4px;
+            cursor: pointer;
+            font-size: 16px;
+        }
+        button:hover {
+            background: #0056b3;
+        }
+        button:disabled {
+            background: #ccc;
+            cursor: not-allowed;
+        }
+        input {
+            padding: 10px;
+            font-size: 16px;
+            border: 1px solid #ddd;
+            border-radius: 4px;
+            width: 300px;
+        }
+        .controls {
+            margin-bottom: 20px;
+        }
+    </style>
+</head>
+<body>
+    <h1>NDJSON Streaming Example</h1>
+    <p>This example demonstrates consuming NDJSON streams from Flink (LLM-style chat streaming).</p>
+
+    <div class="controls">
+        <input type="text" id="prompt" placeholder="Enter your prompt..." value="Tell me a story">
+        <button id="startBtn" onclick="startStream()">Start Stream</button>
+        <button id="stopBtn" onclick="stopStream()" disabled>Stop Stream</button>
+    </div>
+
+    <h3>Response:</h3>
+    <div id="output"></div>
+
+    <script>
+        let reader = null;
+        let controller = null;
+
+        async function startStream() {
+            const prompt = document.getElementById('prompt').value;
+            const output = document.getElementById('output');
+            const startBtn = document.getElementById('startBtn');
+            const stopBtn = document.getElementById('stopBtn');
+
+            output.textContent = '';
+            startBtn.disabled = true;
+            stopBtn.disabled = false;
+
+            try {
+                const response = await fetch(`http://localhost:3333/chat/stream?prompt=${encodeURIComponent(prompt)}`);
+
+                if (!response.ok) {
+                    throw new Error(`HTTP error! status: ${response.status}`);
+                }
+
+                reader = response.body.getReader();
+                const decoder = new TextDecoder();
+                let buffer = '';
+
+                while (true) {
+                    const { done, value } = await reader.read();
+
+                    if (done) {
+                        console.log('Stream complete');
+                        break;
+                    }
+
+                    // Decode chunk
+                    buffer += decoder.decode(value, { stream: true });
+
+                    // Split by newlines
+                    const lines = buffer.split('\n');
+                    buffer = lines.pop() || ''; // Keep incomplete line in buffer
+
+                    // Process each complete line
+                    for (const line of lines) {
+                        if (line.trim()) {
+                            try {
+                                const event = JSON.parse(line);
+
+                                // Append delta to output
+                                if (event.delta) {
+                                    output.textContent += event.delta;
+                                }
+
+                                // Check for completion
+                                if (event.done) {
+                                    console.log('Stream marked as done');
+                                    output.textContent += '\n\n[Stream complete]';
+                                    reader = null;
+                                    startBtn.disabled = false;
+                                    stopBtn.disabled = true;
+                                    return;
+                                }
+
+                                // Handle errors
+                                if (event.error) {
+                                    output.textContent += `\n\nError: ${event.error}`;
+                                    throw new Error(event.error);
+                                }
+                            } catch (parseError) {
+                                console.error('Failed to parse JSON:', parseError, 'Line:', line);
+                            }
+                        }
+                    }
+                }
+            } catch (error) {
+                console.error('Stream error:', error);
+                output.textContent += `\n\nError: ${error.message}`;
+            } finally {
+                reader = null;
+                startBtn.disabled = false;
+                stopBtn.disabled = true;
+            }
+        }
+
+        function stopStream() {
+            if (reader) {
+                reader.cancel();
+                reader = null;
+                document.getElementById('output').textContent += '\n\n[Stream stopped by user]';
+                document.getElementById('startBtn').disabled = false;
+                document.getElementById('stopBtn').disabled = true;
+            }
+        }
+    </script>
+</body>
+</html>