https://github.com/unacro/streaming-message
一个基于 SSE 的消息流 API，用于通过 web 协议实时推送消息（即 ChatGPT 前端交互的实现）
https://github.com/unacro/streaming-message
server-sent-events sse
Last synced: 3 months ago
JSON representation
一个基于 SSE 的消息流 API，用于通过 web 协议实时推送消息（即 ChatGPT 前端交互的实现）
- Host: GitHub
- URL: https://github.com/unacro/streaming-message
- Owner: unacro
- License: gpl-3.0
- Created: 2024-04-19T15:06:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-20T17:04:47.000Z (about 1 year ago)
- Last Synced: 2025-01-21T12:47:27.098Z (5 months ago)
- Topics: server-sent-events, sse
- Language: TypeScript
- Homepage: https://sse.osrp.run
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streaming Message
## 介绍
一个基于 [SSE](https://developer.mozilla.org/zh-CN/docs/Web/API/Server-sent_events) 的消息流 API，用于通过 web 协议实时推送消息（即 ChatGPT 前端交互的实现）
## 安装
```bash
$ git clone https://github.com/unacro/streaming-message.git
$ cd streaming-message
$ cp .env.example .env
$ bun install
$ bun run start
# or 使用其他 Node 环境
$ npm run start # 突然想起并不能 因为肆无忌惮地使用了 Bun 独有的特性 🤣
```
## 原理
```mermaid
%%{init: {"flowchart": {"htmlLabels": false}} }%%
flowchart LR
subgraph room["同一房间"]
controller["`客户端 **后台**
(控制器 _controller_)
输入消息 / 设置房间`"]
player["`客户端 **前台**
(播放器 _player_)
花式展示消息`"]
end
server["`服务端
_server_
消息路由`"]
controller -->|"触发 API\n(HTTP 请求)"| server
server -->|"推送消息\n(SSE 事件)"| player
```
## 用法
### 网页客户端
接收端访问：
```
http://localhost:8000/
```
发送端访问：
```
http://localhost:8000/admin
```
在线预览 Demo：[`sse.osrp.run`](https://sse.osrp.run/)\
发送端：[`sse.osrp.run/admin`](https://sse.osrp.run/admin)（临时 token 为 `whatever`）
### 命令行
```bash
# Linux Bash
export TMP_SSE_API="http://localhost:8000"
export TMP_SSE_TOKEN="your_super_secret_token_here"
# Windows PowerShell
$TMP_SSE_API="http://localhost:8000"
$TMP_SSE_TOKEN="your_super_secret_token_here"
```
#### 建立连接
```bash
curl -H Accept:text/event-stream "${TMP_SSE_API}/api/v1/events"
```
#### 发送消息
GET API：
```bash
curl "${TMP_SSE_API}/api/v1/send/otto?token=${TMP_SSE_TOKEN}&msg=冲！冲刺！"
```
POST API (verified by header)：
```bash
curl "$TMP_SSE_API/api/v1/send" \
-H "Authorization: Bearer ${TMP_SSE_TOKEN}" \
-H "Content-Type: application/json" \
-d '{"speaker":"♿饲猫棍哥♿","data":{"message":"那我缺的营养这一块谁给我补啊？","verified_by":"Request Header"},"meta":"custom"}'
```
POST API (verified by body)：
```bash
curl "$TMP_SSE_API/api/v1/send" \
-H "Content-Type: application/json" \
-d '{"token":"your_super_secret_token_here","speaker":"长期素食","data":{"message":"还追！还追！移速七百多还追！！！","verified_by":"Request Body"},"meta":"custom"}'
```
## Todo
- [ ] 实现独立的会话管理系统，以允许当多个客户端同时存在时，消息互相独立
- [ ] 用 TS 重写浏览器 SSE 客户端 JS 标准实现 `sse-client.js`，编译为 ES5 作为通用库
- [ ] 前台（player）实现类似 [Echo-Live](https://github.com/sheep-realms/Echo-Live) 的 galgame 式对话框 & 打字机效果
- [ ] 后台（controller）结合 [Tailwind CSS](https://tailwindcss.com/) + [daisyUI](https://daisyui.com/) 实现交互，进行输入和房间设置
- [ ] 后台需要登录验证，JWT 双 token 模式鉴权，临时 token 6 小时，刷新 token 14 天
- [ ] 以 SQLite 作为数据库实现多用户系统
- [ ] 后台在线时服务端发送 heartbeat 心跳的 meta 元消息给前台证明细粒度（三次心跳包间隔）的实时在线状态
- [ ] 会话间分房间独立，房间 ID（不区分大小写，对齐 HTTP URL 标准）通过 path 指定，需要通过 `[a-zA-Z0-9]+` 正则验证合法性，ID 非法和不存在的房间默认 fallback 到轮询一言 API
- [ ] Dockerfile 打包容器镜像