feat(sse): add @tsed/sse package

packages/third-parties/sse/.npmignore

@@ -0,0 +1,5 @@
+src
+test
+tsconfig.compile.json
+tsconfig.json
+*.tsbuildinfo

packages/third-parties/sse/.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
+}

packages/third-parties/sse/jest.config.js

@@ -0,0 +1,20 @@
+// 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", "<rootDir>/test"],
+  moduleNameMapper: {
+    ...config.moduleNameMapper,
+    "^@tsed/socketio$": "<rootDir>/src/index.ts"
+  },
+  coverageThreshold: {
+    global: {
+      statements: 0,
+      branches: 0,
+      functions: 0,
+      lines: 0
+    }
+  }
+};

packages/third-parties/sse/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@tsed/sse",
+  "version": "7.77.0",
+  "description": "Socket.io package for Ts.ED framework",
+  "keywords": [
+    "tsed",
+    "socket.io",
+    "socket",
+    "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": "workspace:*",
+    "@tsed/common": "workspace:*",
+    "@tsed/core": "workspace:*",
+    "@tsed/di": "workspace:*",
+    "@tsed/json-mapper": "workspace:*",
+    "@tsed/openspec": "workspace:*",
+    "@tsed/platform-middlewares": "workspace:*",
+    "@tsed/schema": "workspace:*",
+    "@tsed/socketio-testing": "workspace:*",
+    "@tsed/typescript": "workspace:*",
+    "eslint": "^8.57.0",
+    "express": "^4.19.1",
+    "jest": "^29.7.0",
+    "typescript": "4.9.5"
+  },
+  "peerDependencies": {
+    "@tsed/di": "7.77.0",
+    "@tsed/json-mapper": "7.77.0",
+    "@tsed/logger": ">=6.7.5",
+    "@tsed/platform-middlewares": "7.77.0",
+    "@tsed/schema": "7.77.0"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/platform-middlewares": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    }
+  }
+}

packages/third-parties/sse/readme.md

@@ -0,0 +1,172 @@
+<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/socket-io
+
+Server-send event 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 Socket.io, we need to install the [Socket.io](https://www.npmjs.com/package/socket.io) 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 socketio Ts.ED module
+
+@Configuration({
+  sse: {}
+})
+export class Server {}
+```
+
+::: warning
+`compression` middleware should be disabled for correct SSE work
+:::
+
+## Enable event-stream
+
+To enable the event-stream, 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(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 - 2022 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.

packages/third-parties/sse/src/decorators/eventStream.ts

@@ -0,0 +1,15 @@
+import {StoreSet, useDecorators} from "@tsed/core";
+
+export interface EventStreamOpts {
+  headers?: Record<string, string>;
+  event?: string;
+}
+
+export function eventStream(opts: EventStreamOpts) {
+  return useDecorators(
+    StoreSet(EventStreamMiddleware, opts),
+    Use(EventStreamMiddleware),
+    Header("Content-Type", "text/event-stream"),
+    Accept("text/event-stream")
+  );
+}

packages/third-parties/sse/src/decorators/eventStreamCtx.ts

@@ -0,0 +1,8 @@
+import {Context} from "@tsed/platform-params";
+import type {EventStreamContext} from "../domain/EventStreamContext";
+
+export type EventStreamCtx = EventStreamContext;
+
+export function EventStreamCtx() {
+  return Context("EventStreamContext");
+}