@tsed/sse 7.79.0

package/.nycrc

@@ -0,0 +1,27 @@
+{
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "**/*.spec.ts",
+    "**/*.d.ts",
+    "node_modules",
+    "**/interfaces/**",
+    "**/index.ts"
+  ],
+  "extension": [
+    ".ts"
+  ],
+  "require": [],
+  "reporter": [
+    "text-summary",
+    "html",
+    "lcov",
+    "json"
+  ],
+  "check-coverage": true,
+  "statements": 100,
+  "branches": 81.56,
+  "functions": 97.33,
+  "lines": 100
+}

package/jest.config.js

@@ -0,0 +1,16 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+const config = require("@tsed/jest-config");
+
+module.exports = {
+  ...config,
+  roots: ["<rootDir>/src"],
+  coverageThreshold: {
+    global: {
+      statements: 0,
+      branches: 0,
+      functions: 0,
+      lines: 0
+    }
+  }
+};

package/lib/cjs/decorators/eventStream.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventStream = void 0;
+const core_1 = require("@tsed/core");
+const platform_middlewares_1 = require("@tsed/platform-middlewares");
+const schema_1 = require("@tsed/schema");
+const EventStreamMiddleware_1 = require("../middlewares/EventStreamMiddleware");
+function EventStream(opts = {}) {
+    return (0, core_1.useDecorators)((0, core_1.StoreSet)(EventStreamMiddleware_1.EventStreamMiddleware, opts), (0, platform_middlewares_1.Use)(EventStreamMiddleware_1.EventStreamMiddleware), (0, schema_1.AcceptMime)("text/event-stream"), (0, schema_1.Header)("Content-Type", "text/event-stream"));
+}
+exports.EventStream = EventStream;
+//# sourceMappingURL=eventStream.js.map

package/lib/cjs/decorators/eventStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventStream.js","sourceRoot":"","sources":["../../../src/decorators/eventStream.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AACnD,qEAA+C;AAC/C,yCAAgD;AAChD,gFAA2E;AAO3E,SAAgB,WAAW,CAAC,OAAwB,EAAE;IACpD,OAAO,IAAA,oBAAa,EAClB,IAAA,eAAQ,EAAC,6CAAqB,EAAE,IAAI,CAAC,EACrC,IAAA,0BAAG,EAAC,6CAAqB,CAAC,EAC1B,IAAA,mBAAU,EAAC,mBAAmB,CAAC,EAC/B,IAAA,eAAM,EAAC,cAAc,EAAE,mBAAmB,CAAC,CAC5C,CAAC;AACJ,CAAC;AAPD,kCAOC"}

package/lib/cjs/decorators/eventStreamCtx.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventStreamCtx = void 0;
+const platform_params_1 = require("@tsed/platform-params");
+function EventStreamCtx() {
+    return (0, platform_params_1.Context)("EventStreamContext");
+}
+exports.EventStreamCtx = EventStreamCtx;
+//# sourceMappingURL=eventStreamCtx.js.map

package/lib/cjs/decorators/eventStreamCtx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventStreamCtx.js","sourceRoot":"","sources":["../../../src/decorators/eventStreamCtx.ts"],"names":[],"mappings":";;;AAAA,2DAA8C;AAK9C,SAAgB,cAAc;IAC5B,OAAO,IAAA,yBAAO,EAAC,oBAAoB,CAAC,CAAC;AACvC,CAAC;AAFD,wCAEC"}

package/lib/cjs/domain/EventStreamContext.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventStreamContext = void 0;
+const core_1 = require("@tsed/core");
+const platform_response_filter_1 = require("@tsed/platform-response-filter");
+class EventStreamContext {
+    $ctx;
+    opts;
+    responseFilter;
+    #isDone = false;
+    constructor({ $ctx, ...opts }) {
+        this.$ctx = $ctx;
+        this.opts = opts;
+        this.responseFilter = this.$ctx.injector.get(platform_response_filter_1.PlatformResponseFilter);
+    }
+    writeHead(headers = {}) {
+        console.log("this.$ctx", this.$ctx);
+        this.on("end", () => {
+            this.$ctx.logger.info({
+                event: "SSE_ENDED"
+            });
+            this.$ctx.getRes().end();
+            this.#isDone = true;
+        });
+        this.on("close", () => {
+            this.$ctx.logger.info({
+                event: "SSE_CLOSED_BY_CLIENT"
+            });
+            this.$ctx.getRes().end();
+            this.#isDone = true;
+        });
+        this.$ctx.getRes().writeHead(200, {
+            ...this.opts.headers,
+            ...headers,
+            "Content-Type": "text/event-stream",
+            "Cache-Control": "no-cache",
+            Connection: "keep-alive"
+        });
+    }
+    on(event, listener) {
+        this.$ctx.getRes().on(event, listener);
+        return this;
+    }
+    subscribe(observable) {
+        observable.subscribe((data) => {
+            this.emit(this.opts.event, data);
+        });
+        return this;
+    }
+    stream(stream) {
+        const listener = (data) => {
+            if (this.isDone()) {
+                stream.off("data", listener);
+            }
+            else {
+                this.emit(this.opts.event, data);
+            }
+        };
+        stream.on("data", listener);
+    }
+    emit(event, data) {
+        if (this.isDone()) {
+            return;
+        }
+        const { $ctx } = this;
+        if (data === undefined) {
+            return this;
+        }
+        if (Buffer.isBuffer(data)) {
+            data = data.toString("utf8");
+        }
+        if ((0, core_1.isBoolean)(data) || (0, core_1.isNumber)(data) || (0, core_1.isString)(data) || (0, core_1.isDate)(data) || data === null) {
+            this.write({
+                event: event || "",
+                data: JSON.stringify(data)
+            });
+            return this;
+        }
+        this.responseFilter
+            .serialize(data, $ctx)
+            .then((data) => {
+            return this.responseFilter.transform(data, $ctx);
+        })
+            .then((data) => {
+            data = JSON.stringify(data);
+            this.write({
+                event: event || "",
+                data: data
+            });
+        });
+        return this;
+    }
+    write(obj) {
+        const values = Object.entries(obj)
+            .map(([key, value]) => {
+            return `${key}: ${value}`;
+        })
+            .join("\n");
+        this.$ctx.getRes().write(`${values}\n\n`);
+    }
+    isDone() {
+        return this.#isDone;
+    }
+    end() {
+        this.#isDone = true;
+        this.$ctx.getRes().end();
+    }
+}
+exports.EventStreamContext = EventStreamContext;
+//# sourceMappingURL=EventStreamContext.js.map

package/lib/cjs/domain/EventStreamContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventStreamContext.js","sourceRoot":"","sources":["../../../src/domain/EventStreamContext.ts"],"names":[],"mappings":";;;AACA,qCAAiE;AACjE,6EAAsE;AAStE,MAAa,kBAAkB;IACrB,IAAI,CAAkB;IACtB,IAAI,CAAkB;IACtB,cAAc,CAAyB;IAC/C,OAAO,GAAG,KAAK,CAAC;IAEhB,YAAY,EAAC,IAAI,EAAE,GAAG,IAAI,EAA4B;QACpD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAyB,iDAAsB,CAAE,CAAC;IAChG,CAAC;IAED,SAAS,CAAC,UAAkC,EAAE;QAC5C,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACpB,KAAK,EAAE,WAAW;aACnB,CAAC,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACpB,KAAK,EAAE,sBAAsB;aAC9B,CAAC,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE;YAChC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO;YACpB,GAAG,OAAO;YACV,cAAc,EAAE,mBAAmB;YACnC,eAAe,EAAE,UAAU;YAC3B,UAAU,EAAE,YAAY;SACzB,CAAC,CAAC;IACL,CAAC;IAED,EAAE,CAAC,KAAa,EAAE,QAAkC;QAClD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,UAA+B;QACvC,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAA4C;QACjD,MAAM,QAAQ,GAAG,CAAC,IAAa,EAAE,EAAE;YACjC,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;gBACjB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;aAC9B;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;aAClC;QACH,CAAC,CAAC;QAEF,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,KAAyB,EAAE,IAAa;QAC3C,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YACjB,OAAO;SACR;QACD,MAAM,EAAC,IAAI,EAAC,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,OAAO,IAAI,CAAC;SACb;QAED,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACzB,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC9B;QAED,IAAI,IAAA,gBAAS,EAAC,IAAI,CAAC,IAAI,IAAA,eAAQ,EAAC,IAAI,CAAC,IAAI,IAAA,eAAQ,EAAC,IAAI,CAAC,IAAI,IAAA,aAAM,EAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE;YACxF,IAAI,CAAC,KAAK,CAAC;gBACT,KAAK,EAAE,KAAK,IAAI,EAAE;gBAClB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;SACb;QAED,IAAI,CAAC,cAAc;aAChB,SAAS,CAAC,IAAI,EAAE,IAAW,CAAC;aAC5B,IAAI,CAAC,CAAC,IAAa,EAAE,EAAE;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,IAAW,CAAC,CAAC;QAC1D,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,IAAa,EAAE,EAAE;YACtB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE5B,IAAI,CAAC,KAAK,CAAC;gBACT,KAAK,EAAE,KAAK,IAAI,EAAE;gBAClB,IAAI,EAAE,IAAc;aACrB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEL,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAA2B;QAC/B,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACpB,OAAO,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC;QAC5B,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,GAAG;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;IAC3B,CAAC;CACF;AAxHD,gDAwHC"}

package/lib/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+tslib_1.__exportStar(require("./decorators/eventStream.js"), exports);
+tslib_1.__exportStar(require("./decorators/eventStreamCtx.js"), exports);
+tslib_1.__exportStar(require("./domain/EventStreamContext.js"), exports);
+tslib_1.__exportStar(require("./interceptors/EventStreamInterceptor.js"), exports);
+tslib_1.__exportStar(require("./middlewares/EventStreamMiddleware.js"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,sEAA4C;AAC5C,yEAA+C;AAC/C,yEAA+C;AAC/C,mFAAyD;AACzD,iFAAuD"}

package/lib/cjs/interceptors/EventStreamInterceptor.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventStreamInterceptor = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const core_1 = require("@tsed/core");
+const di_1 = require("@tsed/di");
+let EventStreamInterceptor = class EventStreamInterceptor {
+    $ctx;
+    async intercept(context) {
+        const result = await context.next();
+        const eventStream = this.$ctx.get("EventStreamContext");
+        if (eventStream) {
+            if ((0, core_1.isObservable)(result)) {
+                eventStream.subscribe(result);
+                return;
+            }
+            if ((0, core_1.isStream)(result)) {
+                eventStream.stream(result);
+                return;
+            }
+        }
+        return result;
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.InjectContext)(),
+    tslib_1.__metadata("design:type", Function)
+], EventStreamInterceptor.prototype, "$ctx", void 0);
+EventStreamInterceptor = tslib_1.__decorate([
+    (0, di_1.Injectable)()
+], EventStreamInterceptor);
+exports.EventStreamInterceptor = EventStreamInterceptor;
+//# sourceMappingURL=EventStreamInterceptor.js.map

package/lib/cjs/interceptors/EventStreamInterceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventStreamInterceptor.js","sourceRoot":"","sources":["../../../src/interceptors/EventStreamInterceptor.ts"],"names":[],"mappings":";;;;AACA,yCAA2C;AAC3C,qCAAkD;AAElD,iCAAoC;AAK7B,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAEvB,IAAI,CAAkB;IAEhC,KAAK,CAAC,SAAS,CAAC,OAA2B;QACzC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,oBAAoB,CAAC,CAAC;QAE5E,IAAI,WAAW,EAAE;YACf,IAAI,IAAA,mBAAY,EAAC,MAAM,CAAC,EAAE;gBACxB,WAAW,CAAC,SAAS,CAAC,MAA6B,CAAC,CAAC;gBAErD,OAAO;aACR;YAED,IAAI,IAAA,eAAQ,EAAC,MAAM,CAAC,EAAE;gBACpB,WAAW,CAAC,MAAM,CAAC,MAA+B,CAAC,CAAC;gBAEpD,OAAO;aACR;SACF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AAvBC;IAAC,IAAA,sBAAa,GAAE;;oDACgB;AAFrB,sBAAsB;IADlC,IAAA,eAAU,GAAE;GACA,sBAAsB,CAwBlC;AAxBY,wDAAsB"}

package/lib/cjs/middlewares/EventStreamMiddleware.js

@@ -0,0 +1,33 @@
+"use strict";
+var EventStreamMiddleware_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventStreamMiddleware = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const platform_middlewares_1 = require("@tsed/platform-middlewares");
+const EventStreamContext_1 = require("../domain/EventStreamContext");
+let EventStreamMiddleware = EventStreamMiddleware_1 = class EventStreamMiddleware {
+    use($ctx) {
+        const opts = $ctx.endpoint.store.get(EventStreamMiddleware_1, {});
+        // Enable stream logs
+        $ctx.logger.flush();
+        $ctx.logger.maxStackSize = 0;
+        const eventStream = new EventStreamContext_1.EventStreamContext({
+            $ctx,
+            ...opts
+        });
+        $ctx.set("EventStreamContext", eventStream);
+        eventStream.writeHead();
+    }
+};
+tslib_1.__decorate([
+    tslib_1.__param(0, (0, common_1.Context)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [common_1.PlatformContext]),
+    tslib_1.__metadata("design:returntype", void 0)
+], EventStreamMiddleware.prototype, "use", null);
+EventStreamMiddleware = EventStreamMiddleware_1 = tslib_1.__decorate([
+    (0, platform_middlewares_1.Middleware)()
+], EventStreamMiddleware);
+exports.EventStreamMiddleware = EventStreamMiddleware;
+//# sourceMappingURL=EventStreamMiddleware.js.map

package/lib/cjs/middlewares/EventStreamMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventStreamMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/EventStreamMiddleware.ts"],"names":[],"mappings":";;;;;AAAA,yCAAsD;AACtD,qEAAsD;AACtD,qEAAgE;AAGzD,IAAM,qBAAqB,6BAA3B,MAAM,qBAAqB;IAChC,GAAG,CAAY,IAAqB;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,uBAAqB,EAAE,EAAE,CAAC,CAAC;QAEhE,qBAAqB;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;QAE7B,MAAM,WAAW,GAAG,IAAI,uCAAkB,CAAC;YACzC,IAAI;YACJ,GAAG,IAAI;SACR,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;QAE5C,WAAW,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;CACF,CAAA;AAhBC;IAAK,mBAAA,IAAA,gBAAO,GAAE,CAAA;;6CAAO,wBAAe;;gDAenC;AAhBU,qBAAqB;IADjC,IAAA,iCAAU,GAAE;GACA,qBAAqB,CAiBjC;AAjBY,sDAAqB"}

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/esm/decorators/eventStream.js

@@ -0,0 +1,8 @@
+import { StoreSet, useDecorators } from "@tsed/core";
+import { Use } from "@tsed/platform-middlewares";
+import { Header, AcceptMime } from "@tsed/schema";
+import { EventStreamMiddleware } from "../middlewares/EventStreamMiddleware.js";
+export function EventStream(opts = {}) {
+    return useDecorators(StoreSet(EventStreamMiddleware, opts), Use(EventStreamMiddleware), AcceptMime("text/event-stream"), Header("Content-Type", "text/event-stream"));
+}
+//# sourceMappingURL=eventStream.js.map

package/lib/esm/decorators/eventStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventStream.js","sourceRoot":"","sources":["../../../src/decorators/eventStream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,aAAa,EAAC,MAAM,YAAY,CAAC;AACnD,OAAO,EAAC,GAAG,EAAC,MAAM,4BAA4B,CAAC;AAC/C,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,cAAc,CAAC;AAChD,OAAO,EAAC,qBAAqB,EAAC,MAAM,sCAAsC,CAAC;AAO3E,MAAM,UAAU,WAAW,CAAC,OAAwB,EAAE;IACpD,OAAO,aAAa,CAClB,QAAQ,CAAC,qBAAqB,EAAE,IAAI,CAAC,EACrC,GAAG,CAAC,qBAAqB,CAAC,EAC1B,UAAU,CAAC,mBAAmB,CAAC,EAC/B,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAC5C,CAAC;AACJ,CAAC"}

package/lib/esm/decorators/eventStreamCtx.js

@@ -0,0 +1,5 @@
+import { Context } from "@tsed/platform-params";
+export function EventStreamCtx() {
+    return Context("EventStreamContext");
+}
+//# sourceMappingURL=eventStreamCtx.js.map

package/lib/esm/decorators/eventStreamCtx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventStreamCtx.js","sourceRoot":"","sources":["../../../src/decorators/eventStreamCtx.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,uBAAuB,CAAC;AAK9C,MAAM,UAAU,cAAc;IAC5B,OAAO,OAAO,CAAC,oBAAoB,CAAC,CAAC;AACvC,CAAC"}

package/lib/esm/domain/EventStreamContext.js

@@ -0,0 +1,106 @@
+import { isBoolean, isDate, isNumber, isString } from "@tsed/core";
+import { PlatformResponseFilter } from "@tsed/platform-response-filter";
+export class EventStreamContext {
+    $ctx;
+    opts;
+    responseFilter;
+    #isDone = false;
+    constructor({ $ctx, ...opts }) {
+        this.$ctx = $ctx;
+        this.opts = opts;
+        this.responseFilter = this.$ctx.injector.get(PlatformResponseFilter);
+    }
+    writeHead(headers = {}) {
+        console.log("this.$ctx", this.$ctx);
+        this.on("end", () => {
+            this.$ctx.logger.info({
+                event: "SSE_ENDED"
+            });
+            this.$ctx.getRes().end();
+            this.#isDone = true;
+        });
+        this.on("close", () => {
+            this.$ctx.logger.info({
+                event: "SSE_CLOSED_BY_CLIENT"
+            });
+            this.$ctx.getRes().end();
+            this.#isDone = true;
+        });
+        this.$ctx.getRes().writeHead(200, {
+            ...this.opts.headers,
+            ...headers,
+            "Content-Type": "text/event-stream",
+            "Cache-Control": "no-cache",
+            Connection: "keep-alive"
+        });
+    }
+    on(event, listener) {
+        this.$ctx.getRes().on(event, listener);
+        return this;
+    }
+    subscribe(observable) {
+        observable.subscribe((data) => {
+            this.emit(this.opts.event, data);
+        });
+        return this;
+    }
+    stream(stream) {
+        const listener = (data) => {
+            if (this.isDone()) {
+                stream.off("data", listener);
+            }
+            else {
+                this.emit(this.opts.event, data);
+            }
+        };
+        stream.on("data", listener);
+    }
+    emit(event, data) {
+        if (this.isDone()) {
+            return;
+        }
+        const { $ctx } = this;
+        if (data === undefined) {
+            return this;
+        }
+        if (Buffer.isBuffer(data)) {
+            data = data.toString("utf8");
+        }
+        if (isBoolean(data) || isNumber(data) || isString(data) || isDate(data) || data === null) {
+            this.write({
+                event: event || "",
+                data: JSON.stringify(data)
+            });
+            return this;
+        }
+        this.responseFilter
+            .serialize(data, $ctx)
+            .then((data) => {
+            return this.responseFilter.transform(data, $ctx);
+        })
+            .then((data) => {
+            data = JSON.stringify(data);
+            this.write({
+                event: event || "",
+                data: data
+            });
+        });
+        return this;
+    }
+    write(obj) {
+        const values = Object.entries(obj)
+            .map(([key, value]) => {
+            return `${key}: ${value}`;
+        })
+            .join("\n");
+        this.$ctx.getRes().write(`${values}\n\n`);
+    }
+    isDone() {
+        return this.#isDone;
+    }
+    end() {
+        this.#isDone = true;
+        this.$ctx.getRes().end();
+    }
+}
+//# sourceMappingURL=EventStreamContext.js.map

package/lib/esm/domain/EventStreamContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventStreamContext.js","sourceRoot":"","sources":["../../../src/domain/EventStreamContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAC;AACjE,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAStE,MAAM,OAAO,kBAAkB;IACrB,IAAI,CAAkB;IACtB,IAAI,CAAkB;IACtB,cAAc,CAAyB;IAC/C,OAAO,GAAG,KAAK,CAAC;IAEhB,YAAY,EAAC,IAAI,EAAE,GAAG,IAAI,EAA4B;QACpD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAyB,sBAAsB,CAAE,CAAC;IAChG,CAAC;IAED,SAAS,CAAC,UAAkC,EAAE;QAC5C,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACpB,KAAK,EAAE,WAAW;aACnB,CAAC,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACpB,KAAK,EAAE,sBAAsB;aAC9B,CAAC,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE;YAChC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO;YACpB,GAAG,OAAO;YACV,cAAc,EAAE,mBAAmB;YACnC,eAAe,EAAE,UAAU;YAC3B,UAAU,EAAE,YAAY;SACzB,CAAC,CAAC;IACL,CAAC;IAED,EAAE,CAAC,KAAa,EAAE,QAAkC;QAClD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,UAA+B;QACvC,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAA4C;QACjD,MAAM,QAAQ,GAAG,CAAC,IAAa,EAAE,EAAE;YACjC,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;gBACjB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;aAC9B;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;aAClC;QACH,CAAC,CAAC;QAEF,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,KAAyB,EAAE,IAAa;QAC3C,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YACjB,OAAO;SACR;QACD,MAAM,EAAC,IAAI,EAAC,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,OAAO,IAAI,CAAC;SACb;QAED,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACzB,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC9B;QAED,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE;YACxF,IAAI,CAAC,KAAK,CAAC;gBACT,KAAK,EAAE,KAAK,IAAI,EAAE;gBAClB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;SACb;QAED,IAAI,CAAC,cAAc;aAChB,SAAS,CAAC,IAAI,EAAE,IAAW,CAAC;aAC5B,IAAI,CAAC,CAAC,IAAa,EAAE,EAAE;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,IAAW,CAAC,CAAC;QAC1D,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,IAAa,EAAE,EAAE;YACtB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAE5B,IAAI,CAAC,KAAK,CAAC;gBACT,KAAK,EAAE,KAAK,IAAI,EAAE;gBAClB,IAAI,EAAE,IAAc;aACrB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEL,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAA2B;QAC/B,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACpB,OAAO,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC;QAC5B,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,GAAG;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;IAC3B,CAAC;CACF"}

package/lib/esm/index.js

@@ -0,0 +1,9 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./decorators/eventStream.js";
+export * from "./decorators/eventStreamCtx.js";
+export * from "./domain/EventStreamContext.js";
+export * from "./interceptors/EventStreamInterceptor.js";
+export * from "./middlewares/EventStreamMiddleware.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0CAA0C,CAAC;AACzD,cAAc,wCAAwC,CAAC"}

package/lib/esm/interceptors/EventStreamInterceptor.js

@@ -0,0 +1,31 @@
+import { __decorate, __metadata } from "tslib";
+import { InjectContext } from "@tsed/common";
+import { isStream, isObservable } from "@tsed/core";
+import { Injectable } from "@tsed/di";
+let EventStreamInterceptor = class EventStreamInterceptor {
+    $ctx;
+    async intercept(context) {
+        const result = await context.next();
+        const eventStream = this.$ctx.get("EventStreamContext");
+        if (eventStream) {
+            if (isObservable(result)) {
+                eventStream.subscribe(result);
+                return;
+            }
+            if (isStream(result)) {
+                eventStream.stream(result);
+                return;
+            }
+        }
+        return result;
+    }
+};
+__decorate([
+    InjectContext(),
+    __metadata("design:type", Function)
+], EventStreamInterceptor.prototype, "$ctx", void 0);
+EventStreamInterceptor = __decorate([
+    Injectable()
+], EventStreamInterceptor);
+export { EventStreamInterceptor };
+//# sourceMappingURL=EventStreamInterceptor.js.map

package/lib/esm/interceptors/EventStreamInterceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventStreamInterceptor.js","sourceRoot":"","sources":["../../../src/interceptors/EventStreamInterceptor.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAC,QAAQ,EAAE,YAAY,EAAC,MAAM,YAAY,CAAC;AAElD,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAK7B,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAEvB,IAAI,CAAkB;IAEhC,KAAK,CAAC,SAAS,CAAC,OAA2B;QACzC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,oBAAoB,CAAC,CAAC;QAE5E,IAAI,WAAW,EAAE;YACf,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE;gBACxB,WAAW,CAAC,SAAS,CAAC,MAA6B,CAAC,CAAC;gBAErD,OAAO;aACR;YAED,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACpB,WAAW,CAAC,MAAM,CAAC,MAA+B,CAAC,CAAC;gBAEpD,OAAO;aACR;SACF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AAvBC;IAAC,aAAa,EAAE;;oDACgB;AAFrB,sBAAsB;IADlC,UAAU,EAAE;GACA,sBAAsB,CAwBlC;SAxBY,sBAAsB"}

package/lib/esm/middlewares/EventStreamMiddleware.js

@@ -0,0 +1,30 @@
+var EventStreamMiddleware_1;
+import { __decorate, __metadata, __param } from "tslib";
+import { Context, PlatformContext } from "@tsed/common";
+import { Middleware } from "@tsed/platform-middlewares";
+import { EventStreamContext } from "../domain/EventStreamContext.js";
+let EventStreamMiddleware = EventStreamMiddleware_1 = class EventStreamMiddleware {
+    use($ctx) {
+        const opts = $ctx.endpoint.store.get(EventStreamMiddleware_1, {});
+        // Enable stream logs
+        $ctx.logger.flush();
+        $ctx.logger.maxStackSize = 0;
+        const eventStream = new EventStreamContext({
+            $ctx,
+            ...opts
+        });
+        $ctx.set("EventStreamContext", eventStream);
+        eventStream.writeHead();
+    }
+};
+__decorate([
+    __param(0, Context()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [PlatformContext]),
+    __metadata("design:returntype", void 0)
+], EventStreamMiddleware.prototype, "use", null);
+EventStreamMiddleware = EventStreamMiddleware_1 = __decorate([
+    Middleware()
+], EventStreamMiddleware);
+export { EventStreamMiddleware };
+//# sourceMappingURL=EventStreamMiddleware.js.map

package/lib/esm/middlewares/EventStreamMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventStreamMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/EventStreamMiddleware.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAC,OAAO,EAAE,eAAe,EAAC,MAAM,cAAc,CAAC;AACtD,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,kBAAkB,EAAC,MAAM,8BAA8B,CAAC;AAGzD,IAAM,qBAAqB,6BAA3B,MAAM,qBAAqB;IAChC,GAAG,CAAY,IAAqB;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,uBAAqB,EAAE,EAAE,CAAC,CAAC;QAEhE,qBAAqB;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;QAE7B,MAAM,WAAW,GAAG,IAAI,kBAAkB,CAAC;YACzC,IAAI;YACJ,GAAG,IAAI;SACR,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;QAE5C,WAAW,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;CACF,CAAA;AAhBC;IAAK,WAAA,OAAO,EAAE,CAAA;;qCAAO,eAAe;;gDAenC;AAhBU,qBAAqB;IADjC,UAAU,EAAE;GACA,qBAAqB,CAiBjC;SAjBY,qBAAqB"}

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/lib/types/decorators/eventStream.d.ts

@@ -0,0 +1,5 @@
+export interface EventStreamOpts {
+    headers?: Record<string, string>;
+    event?: string;
+}
+export declare function EventStream(opts?: EventStreamOpts): any;

package/lib/types/decorators/eventStreamCtx.d.ts

@@ -0,0 +1,3 @@
+import type { EventStreamContext } from "../domain/EventStreamContext";
+export type EventStreamCtx = EventStreamContext;
+export declare function EventStreamCtx(): ParameterDecorator;

package/lib/types/domain/EventStreamContext.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { PlatformContext } from "@tsed/common";
+import type { EventEmitter } from "events";
+import type { Observable } from "rxjs";
+import type { EventStreamOpts } from "../decorators/eventStream";
+export type EventStreamContextOptions = {
+    $ctx: PlatformContext;
+} & EventStreamOpts;
+export declare class EventStreamContext {
+    #private;
+    private $ctx;
+    private opts;
+    private responseFilter;
+    constructor({ $ctx, ...opts }: EventStreamContextOptions);
+    writeHead(headers?: Record<string, string>): void;
+    on(event: string, listener: (...args: any[]) => void): this;
+    subscribe(observable: Observable<unknown>): this;
+    stream(stream: NodeJS.ReadableStream | EventEmitter): void;
+    emit(event: string | undefined, data: unknown): this | undefined;
+    write(obj: Record<string, string>): void;
+    isDone(): boolean;
+    end(): void;
+}

package/lib/types/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./decorators/eventStream.js";
+export * from "./decorators/eventStreamCtx.js";
+export * from "./domain/EventStreamContext.js";
+export * from "./interceptors/EventStreamInterceptor.js";
+export * from "./middlewares/EventStreamMiddleware.js";

package/lib/types/interceptors/EventStreamInterceptor.d.ts

@@ -0,0 +1,6 @@
+import type { PlatformContext } from "@tsed/common";
+import type { InterceptorContext, InterceptorMethods } from "@tsed/di";
+export declare class EventStreamInterceptor implements InterceptorMethods {
+    protected $ctx: PlatformContext;
+    intercept(context: InterceptorContext): Promise<unknown>;
+}

package/lib/types/middlewares/EventStreamMiddleware.d.ts

@@ -0,0 +1,4 @@
+import { PlatformContext } from "@tsed/common";
+export declare class EventStreamMiddleware {
+    use($ctx: PlatformContext): void;
+}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@tsed/sse",
+  "version": "7.79.0",
+  "description": "Server-sent events package for Ts.ED framework",
+  "keywords": [
+    "tsed",
+    "server-sent events",
+    "sse",
+    "server",
+    "realtime"
+  ],
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn build:ts",
+    "barrels": "barrels",
+    "start": "ts-node test/app/index.ts",
+    "test": "jest --runInBand --testTimeout 10000 && jest-coverage-thresholds-bumper",
+    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json"
+  },
+  "dependencies": {
+    "tslib": "2.6.1"
+  },
+  "devDependencies": {
+    "@tsed/barrels": "7.79.0",
+    "@tsed/common": "7.79.0",
+    "@tsed/core": "7.79.0",
+    "@tsed/di": "7.79.0",
+    "@tsed/json-mapper": "7.79.0",
+    "@tsed/openspec": "7.79.0",
+    "@tsed/platform-middlewares": "7.79.0",
+    "@tsed/schema": "7.79.0",
+    "@tsed/socketio-testing": "7.79.0",
+    "@tsed/typescript": "7.79.0",
+    "eslint": "^8.57.0",
+    "express": "^4.19.1",
+    "jest": "^29.7.0",
+    "typescript": "4.9.5"
+  },
+  "peerDependencies": {
+    "@tsed/di": "7.79.0",
+    "@tsed/json-mapper": "7.79.0",
+    "@tsed/logger": ">=6.7.5",
+    "@tsed/platform-middlewares": "7.79.0",
+    "@tsed/schema": "7.79.0"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/platform-middlewares": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    }
+  },
+  "repository": "https://github.com/tsedio/tsed",
+  "bugs": {
+    "url": "https://github.com/tsedio/tsed/issues"
+  },
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/third-parties/sse",
+  "author": "Romain Lenzotti",
+  "license": "MIT"
+}

package/readme.md

@@ -0,0 +1,181 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+   <h1>Server-sent events</h1>
+
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.io/getting-started/">Getting started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://api.tsed.io/rest/slack/tsedio/tsed">Slack</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of Ts.ED framework. See website: https://tsed.io/#/tutorials/server-sent-events
+
+Server-sent events let you push data to the client. It's a simple way to send data from the server to the client. The data is sent as a stream of messages, with an optional event name and id. It's a simple way to send data from the server to the client.
+
+## Installation
+
+Before using the Server-sent events, we need to install the `@tsed/sse` module.
+
+```bash
+npm install --save @tsed/sse
+```
+
+Then add the following configuration in your Server:
+
+```typescript
+import {Configuration} from "@tsed/common";
+import "@tsed/sse"; // import sse Ts.ED module
+
+@Configuration({
+  acceptMimes: ["application/json", "text/event-stream"]
+})
+export class Server {}
+```
+
+::: warning
+There is a known issue with the `compression` middleware. The
+`compression` middleware should be disabled to work correctly with Server-sent events.
+:::
+
+## Features
+
+- Support decorator usage to enable event-stream on an endpoint,
+- Support Node.js stream like `EventEmmiter` to emit events from your controller to your consumer,
+- Support `Observable` from `rxjs` to emit events from your controller to your consumer.
+- Support `@tsed/json-mapper` to serialize your model before sending it to the client.
+- Gives an API compatible with Express.js and Koa.js.
+
+## Enable event-stream
+
+To enable the event-stream on an endpoint, you need to use the `@EventStream()` decorator on a method of a controller.
+
+```typescript
+import {Controller} from "@tsed/di";
+import {Get} from "@tsed/schema";
+import {EventStream, EventStreamCtx} from "@tsed/sse";
+
+@Controller("/sse")
+export class MyCtrl {
+  @Get("/events")
+  @EventStream()
+  events(@EventStreamCtx() eventStream: EventStreamCtx) {
+    let intervalId: ReturnType<typeof setInterval>;
+
+    eventStream.on("close", () => {
+      clearInterval(intervalId);
+    });
+
+    eventStream.on("end", () => {
+      clearInterval(intervalId);
+    });
+
+    intervalId = setInterval(() => {
+      // Ts.ED support Model serialization using json-mapper here
+      eventStream.emit("event", new Date());
+    }, 1000);
+  }
+}
+```
+
+### Stream events
+
+You can use Node.js stream like `EventEmmiter` to emit events from your controller to your consumer:
+
+```ts
+import {EventStream} from "@tsed/sse";
+import {Controller} from "@tsed/di";
+import {Get} from "@tsed/schema";
+
+@Controller("/sse")
+export class MyCtrl {
+  private eventEmitter = new EventEmitter();
+
+  $onInit() {
+    setInterval(() => {
+      this.eventEmitter.emit("message", new Date());
+    }, 1000);
+  }
+
+  @Get("/events")
+  @EventStream()
+  events() {
+    return this.eventEmitter;
+  }
+}
+```
+
+### Observable
+
+You can also use `Observable` from `rxjs` to emit events from your controller to your consumer:
+
+```ts
+import {EventStream} from "@tsed/sse";
+import {Controller} from "@tsed/di";
+import {Get} from "@tsed/schema";
+
+@Controller("/sse")
+export class MyCtrl {
+  @Get("/events")
+  @EventStream()
+  events() {
+    const observable = new Observable((observer) => {
+      setInterval(() => {
+        observer.next(new Date());
+      }, 1000);
+    });
+
+    return observable;
+  }
+}
+```
+
+## Documentation
+
+See our documentation https://tsed.io/#/api/index
+
+## Contributors
+
+Please read [contributing guidelines here](https://tsed.io/contributing.html)
+
+<a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - today Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/tsconfig.esm.json

@@ -0,0 +1,54 @@
+{
+  "extends": "@tsed/typescript/tsconfig.node.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types",
+    "composite": true,
+    "noEmit": false
+  },
+  "include": ["src", "src/**/*.json"],
+  "exclude": [
+    "node_modules",
+    "test",
+    "lib",
+    "benchmark",
+    "coverage",
+    "spec",
+    "**/*.benchmark.ts",
+    "**/*.spec.ts",
+    "keys",
+    "jest.config.js",
+    "**/__mock__/**",
+    "webpack.config.js"
+  ],
+  "references": [
+    {
+      "path": "../../di"
+    },
+    {
+      "path": "../../specs/json-mapper"
+    },
+    {
+      "path": "../../platform/platform-middlewares"
+    },
+    {
+      "path": "../../specs/schema"
+    },
+    {
+      "path": "../../platform/common"
+    },
+    {
+      "path": "../../core"
+    },
+    {
+      "path": "../../specs/openspec"
+    },
+    {
+      "path": "../socketio-testing"
+    }
+  ]
+}