@coda-console/protocol 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -0
- package/docs/protocol.md +7 -2
- package/package.json +1 -1
- package/schemas/protocol/v1/session.json +3 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
按 semver。协议自己的大版本写在协议名里（如 `coda/run@1`），与 npm 包版本、插件清单的 v2 独立；更早的版本见 git 历史。
|
|
4
4
|
|
|
5
|
+
## 3.4.0 — 2026-11-09
|
|
6
|
+
|
|
7
|
+
- `coda/session@1` 的 `read`：都不带游标时读最新的 `limit` 条；写清 `before` 是这个游标之前最新的 `limit` 条、`more` 表示更早还有没有；消息总按先后排；`after` 与 `before` 不能同时带（Coda #2311）。
|
|
8
|
+
- `coda/session@1` 的消息加可选的 `senderName`：发送者当时的显示名，大群不必把每个发送者都写进 `status.participants`。
|
|
9
|
+
|
|
5
10
|
## 3.3.0 — 2026-11-09
|
|
6
11
|
|
|
7
12
|
- `coda:choice` 的 `note`：`required` 时选它必须附言（写说明或附上文件），默认 `optional`（Coda #2303 第 3 步：卡片在输入框里填写）。
|
package/docs/protocol.md
CHANGED
|
@@ -293,12 +293,17 @@ status：
|
|
|
293
293
|
|
|
294
294
|
观察方 watch 这条记录，`head` 变了就用 `read` 读游标之后的消息。两个操作都是立即结果，不开运行；`read` 是 `safe` 的：
|
|
295
295
|
|
|
296
|
-
- `read`：输入 `{ after?, before?, limit? }`，`after`、`before` 是游标，`limit` 为 1 到 100；结果 `{ messages, cursor, more }`，没有消息时 `cursor` 为 `null
|
|
296
|
+
- `read`：输入 `{ after?, before?, limit? }`，`after`、`before` 是游标，`limit` 为 1 到 100；结果 `{ messages, cursor, more }`，没有消息时 `cursor` 为 `null`。`messages` 总按先后排，旧的在前：
|
|
297
|
+
- 都不带游标：最新的 `limit` 条，`more` 表示更早还有没有；客户端打开会话时先读这一页；
|
|
298
|
+
- 只带 `after`：这个游标之后的，`more` 表示之后还有没有；
|
|
299
|
+
- 只带 `before`：这个游标之前最新的 `limit` 条，`more` 表示更早还有没有；往前翻页就拿这一页第一条的 `cursor` 作下一次的 `before`；
|
|
300
|
+
- `after` 与 `before` 不能同时带。
|
|
297
301
|
- `post`：输入 `{ text, parts?, replyTo?, mentions? }`；结果 `{ message: { id, cursor } }`。发送者固定是 `self`；Provider 按调用的 `requestId` 只发一次，发送失败就报错。
|
|
298
302
|
|
|
299
|
-
消息是 `{ id, cursor, sender, text, parts?, replyTo?, mentions?, about?, createdAt? }`：
|
|
303
|
+
消息是 `{ id, cursor, sender, senderName?, text, parts?, replyTo?, mentions?, about?, createdAt? }`：
|
|
300
304
|
|
|
301
305
|
- `sender` 与 `mentions` 写参与者 ID，`replyTo` 写消息 ID；
|
|
306
|
+
- `senderName` 是发送者当时的显示名，可选：大群不必把每个发送者都写进 `status.participants`；
|
|
302
307
|
- 回复一条消息就算 @ 了它的发送者，Provider 把被回复消息的发送者也写进 `mentions`：只有 Provider 知道被回复的那条是谁发的，观察方不用记住 Bot 发过哪些消息；
|
|
303
308
|
- `text` 是纯文本兜底，看不懂 `parts` 的一方只看它；
|
|
304
309
|
- 撤回、编辑、表情回应都是一条新消息，`about: { message, change: "edit"|"recall"|"reaction", value? }` 指向旧消息；
|
package/package.json
CHANGED
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
},
|
|
59
59
|
"operations": {
|
|
60
60
|
"read": {
|
|
61
|
-
"description": "
|
|
61
|
+
"description": "读消息，limit 为 1 到 100，消息总按先后排（旧在前）；立即结果。都不带游标时读最新的 limit 条，more 表示更早还有没有；带 after 读这个游标之后的，more 表示之后还有没有；带 before 读这个游标之前最新的 limit 条，more 表示更早还有没有。after 与 before 不能同时带。",
|
|
62
62
|
"safe": true,
|
|
63
63
|
"input": {
|
|
64
64
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
@@ -68,6 +68,7 @@
|
|
|
68
68
|
"before": {"type": "string", "minLength": 1, "maxLength": 2048},
|
|
69
69
|
"limit": {"type": "integer", "minimum": 1, "maximum": 100}
|
|
70
70
|
},
|
|
71
|
+
"not": {"required": ["after", "before"]},
|
|
71
72
|
"additionalProperties": false
|
|
72
73
|
},
|
|
73
74
|
"result": {
|
|
@@ -109,6 +110,7 @@
|
|
|
109
110
|
"id": {"$ref": "#/$defs/id"},
|
|
110
111
|
"cursor": {"$ref": "#/$defs/id"},
|
|
111
112
|
"sender": {"$ref": "#/$defs/id", "description": "参与者 ID"},
|
|
113
|
+
"senderName": {"type": "string", "maxLength": 200, "description": "发送者当时的显示名，可选；大群不必把每个发送者都写进 status.participants"},
|
|
112
114
|
"text": {"type": "string", "description": "纯文本兜底"},
|
|
113
115
|
"parts": {"type": "array", "items": {"$ref": "#/$defs/part"}},
|
|
114
116
|
"replyTo": {"$ref": "#/$defs/id", "description": "回复的消息 ID"},
|