open-agent-docs 0.3.0__py3-none-any.whl
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.
- open_agent_docs/__init__.py +86 -0
- open_agent_docs/_base_client.py +667 -0
- open_agent_docs/_client.py +112 -0
- open_agent_docs/_embed.py +83 -0
- open_agent_docs/_errors.py +206 -0
- open_agent_docs/_files.py +51 -0
- open_agent_docs/_generated/__init__.py +2 -0
- open_agent_docs/_generated/models.py +1378 -0
- open_agent_docs/_generated/resources.py +4300 -0
- open_agent_docs/_models.py +17 -0
- open_agent_docs/_pagination.py +132 -0
- open_agent_docs/_server.py +330 -0
- open_agent_docs/_sse.py +335 -0
- open_agent_docs/_types.py +35 -0
- open_agent_docs/_utils.py +15 -0
- open_agent_docs/_version.py +1 -0
- open_agent_docs/_webhook.py +85 -0
- open_agent_docs/py.typed +0 -0
- open_agent_docs/types.py +3 -0
- open_agent_docs-0.3.0.dist-info/METADATA +266 -0
- open_agent_docs-0.3.0.dist-info/RECORD +22 -0
- open_agent_docs-0.3.0.dist-info/WHEEL +4 -0
|
@@ -0,0 +1,1378 @@
|
|
|
1
|
+
# 由 codegen 生成,不要手改:python sdks/python/codegen/generate.py(来源 docs/openapi.json、sdks/operations.json)
|
|
2
|
+
"""接口的模型(docs/openapi.json 的 components.schemas 和 webhooks)。"""
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import warnings
|
|
6
|
+
from typing import Any, Dict, List, Literal, Optional, Type, Union
|
|
7
|
+
|
|
8
|
+
from pydantic import Field
|
|
9
|
+
|
|
10
|
+
from .._models import BaseModel
|
|
11
|
+
|
|
12
|
+
__all__ = [
|
|
13
|
+
"Ack",
|
|
14
|
+
"Acked",
|
|
15
|
+
"AddRow",
|
|
16
|
+
"AddRows",
|
|
17
|
+
"AddedRows",
|
|
18
|
+
"Agent",
|
|
19
|
+
"AgentList",
|
|
20
|
+
"AgentNotes",
|
|
21
|
+
"AgentNotification",
|
|
22
|
+
"AgentView",
|
|
23
|
+
"Anchor",
|
|
24
|
+
"AuthConfigBody",
|
|
25
|
+
"AuthMode",
|
|
26
|
+
"AuthorRef",
|
|
27
|
+
"Authors",
|
|
28
|
+
"BlockBody",
|
|
29
|
+
"BlockContent",
|
|
30
|
+
"BlockDiff",
|
|
31
|
+
"BlockIds",
|
|
32
|
+
"CellChange",
|
|
33
|
+
"CellOp",
|
|
34
|
+
"CommentCreatedEvent",
|
|
35
|
+
"CommentView",
|
|
36
|
+
"Content",
|
|
37
|
+
"CreateAgent",
|
|
38
|
+
"CreatePage",
|
|
39
|
+
"CreatedAgent",
|
|
40
|
+
"DbChangedEvent",
|
|
41
|
+
"DbHistory",
|
|
42
|
+
"DbHistoryItem",
|
|
43
|
+
"DbInfo",
|
|
44
|
+
"DbProp",
|
|
45
|
+
"DbRow",
|
|
46
|
+
"DbSchema",
|
|
47
|
+
"DbSchemaEvent",
|
|
48
|
+
"DbSort",
|
|
49
|
+
"DbUndone",
|
|
50
|
+
"DbView",
|
|
51
|
+
"Deleted",
|
|
52
|
+
"DiffTo",
|
|
53
|
+
"DocMark",
|
|
54
|
+
"DocNode",
|
|
55
|
+
"EditComment",
|
|
56
|
+
"ErrorBody",
|
|
57
|
+
"ErrorCode",
|
|
58
|
+
"ErrorInfo",
|
|
59
|
+
"Ids",
|
|
60
|
+
"ImportForm",
|
|
61
|
+
"Inbox",
|
|
62
|
+
"InboxNotification",
|
|
63
|
+
"InviteBy",
|
|
64
|
+
"InviteInfo",
|
|
65
|
+
"InviteList",
|
|
66
|
+
"InviteView",
|
|
67
|
+
"InviteWorkspace",
|
|
68
|
+
"LoginBody",
|
|
69
|
+
"Me",
|
|
70
|
+
"MePatch",
|
|
71
|
+
"MeUser",
|
|
72
|
+
"MeWorkspace",
|
|
73
|
+
"Member",
|
|
74
|
+
"MemberList",
|
|
75
|
+
"MemberRole",
|
|
76
|
+
"MemberUser",
|
|
77
|
+
"NewDb",
|
|
78
|
+
"NewInvite",
|
|
79
|
+
"NewSecret",
|
|
80
|
+
"NewThread",
|
|
81
|
+
"NewToken",
|
|
82
|
+
"NoteAgent",
|
|
83
|
+
"NoteComment",
|
|
84
|
+
"NotePage",
|
|
85
|
+
"Notify",
|
|
86
|
+
"Page",
|
|
87
|
+
"PageList",
|
|
88
|
+
"PagePurgedEvent",
|
|
89
|
+
"PasswordBody",
|
|
90
|
+
"PatchAgent",
|
|
91
|
+
"PatchPage",
|
|
92
|
+
"PatchRows",
|
|
93
|
+
"PatchThread",
|
|
94
|
+
"Patched",
|
|
95
|
+
"Pressed",
|
|
96
|
+
"PrincipalKind",
|
|
97
|
+
"PropType",
|
|
98
|
+
"PutContent",
|
|
99
|
+
"PutShare",
|
|
100
|
+
"PutViews",
|
|
101
|
+
"QueryGroup",
|
|
102
|
+
"QueryReq",
|
|
103
|
+
"QueryResult",
|
|
104
|
+
"QueryRow",
|
|
105
|
+
"ReadCount",
|
|
106
|
+
"ReadNotes",
|
|
107
|
+
"RelationConf",
|
|
108
|
+
"Reply",
|
|
109
|
+
"Restored",
|
|
110
|
+
"RestoredPage",
|
|
111
|
+
"Role",
|
|
112
|
+
"RoleBody",
|
|
113
|
+
"RollupConf",
|
|
114
|
+
"RowsDelta",
|
|
115
|
+
"SaveBody",
|
|
116
|
+
"SchemaChanged",
|
|
117
|
+
"SchemaOps",
|
|
118
|
+
"SchemaUndone",
|
|
119
|
+
"Scope",
|
|
120
|
+
"SearchResult",
|
|
121
|
+
"SearchResults",
|
|
122
|
+
"SelectOption",
|
|
123
|
+
"Seq",
|
|
124
|
+
"ShareView",
|
|
125
|
+
"SignFileUrls",
|
|
126
|
+
"SignedFileUrls",
|
|
127
|
+
"SignupBody",
|
|
128
|
+
"SignupMode",
|
|
129
|
+
"ThreadList",
|
|
130
|
+
"ThreadView",
|
|
131
|
+
"TrashItem",
|
|
132
|
+
"TrashList",
|
|
133
|
+
"Undo",
|
|
134
|
+
"UndoBody",
|
|
135
|
+
"UnfurlCard",
|
|
136
|
+
"UploadForm",
|
|
137
|
+
"Uploaded",
|
|
138
|
+
"VersionAuthor",
|
|
139
|
+
"VersionContent",
|
|
140
|
+
"VersionDiff",
|
|
141
|
+
"VersionList",
|
|
142
|
+
"VersionMeta",
|
|
143
|
+
"ViewObj",
|
|
144
|
+
"ViewType",
|
|
145
|
+
"Views",
|
|
146
|
+
"Workspace",
|
|
147
|
+
"WsPatch",
|
|
148
|
+
]
|
|
149
|
+
|
|
150
|
+
# 有的字段叫 schema、json,和 pydantic.BaseModel 的老方法同名:照样能用(拿到的是字段),警告压掉
|
|
151
|
+
warnings.filterwarnings("ignore", message=r"Field name \"(construct|copy|dict|fields|from_orm|json|parse_obj|parse_raw|schema|validate)\" .* shadows an attribute")
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
class Ack(BaseModel):
|
|
155
|
+
"""处理完了:给 ids,或者 upto(编号 ≤ upto 的都算),至少给一个。"""
|
|
156
|
+
ids: Optional[List[int]] = None
|
|
157
|
+
"""这些编号"""
|
|
158
|
+
upto: Optional[int] = None
|
|
159
|
+
"""编号 ≤ 这个的"""
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
class Acked(BaseModel):
|
|
163
|
+
acked: int
|
|
164
|
+
"""标了几条"""
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
class AddRow(BaseModel):
|
|
168
|
+
after: Optional[str] = None
|
|
169
|
+
"""排在这一行后面(不给放最后)"""
|
|
170
|
+
body: Optional[str] = None
|
|
171
|
+
"""行页面的正文(Markdown)"""
|
|
172
|
+
props: Optional[Dict[str, Any]] = None
|
|
173
|
+
"""属性:键是属性的 key 或名字,值是存的样子(选项也可以写名字)"""
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
class AddRows(BaseModel):
|
|
177
|
+
rows: List[AddRow]
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
class AddedRows(BaseModel):
|
|
181
|
+
ids: List[str]
|
|
182
|
+
"""新行的 id(和给的顺序一样)"""
|
|
183
|
+
seq: int
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
class Agent(BaseModel):
|
|
187
|
+
about: str
|
|
188
|
+
created_at: int
|
|
189
|
+
created_by: Optional[str] = None
|
|
190
|
+
id: str
|
|
191
|
+
last_used_at: Optional[int] = None
|
|
192
|
+
name: str
|
|
193
|
+
revoked_at: Optional[int] = None
|
|
194
|
+
scope: Scope
|
|
195
|
+
webhook: Optional[str] = None
|
|
196
|
+
workspace_id: str
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
class AgentList(BaseModel):
|
|
200
|
+
agents: List[AgentView]
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
class AgentNotes(BaseModel):
|
|
204
|
+
next_cursor: Optional[str] = None
|
|
205
|
+
"""取满了一页时是最后一条的编号,带 `?cursor=` 接着取;没有就是取完了"""
|
|
206
|
+
notifications: List[AgentNotification]
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
class AgentNotification(BaseModel):
|
|
210
|
+
"""Agent 收到的一条通知(webhook 的正文;长轮询 / SSE 取到的也是这样)。"""
|
|
211
|
+
agent: NoteAgent
|
|
212
|
+
block_id: Optional[str] = None
|
|
213
|
+
"""评论挂在哪一块上(对整页的评论是 null)"""
|
|
214
|
+
comment: NoteComment
|
|
215
|
+
created_at: int
|
|
216
|
+
id: int
|
|
217
|
+
"""通知编号(处理完带回来当 after / cursor)"""
|
|
218
|
+
page: NotePage
|
|
219
|
+
prompt: str
|
|
220
|
+
"""一段可以直接当消息发给 Agent 的话(按 Agent 的语言)"""
|
|
221
|
+
quote: Optional[str] = None
|
|
222
|
+
"""选中的原文"""
|
|
223
|
+
thread_id: str
|
|
224
|
+
type: str
|
|
225
|
+
"""comment"""
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
class AgentView(Agent):
|
|
229
|
+
"""Agent 列表里的一项:加上没处理的通知数和最近的 webhook 错误。"""
|
|
230
|
+
pending: int
|
|
231
|
+
webhook_error: Optional[str] = None
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
class Anchor(BaseModel):
|
|
235
|
+
"""评论挂在哪:一段文字(start / end 是网页给的 Yjs RelativePosition,服务器原样存)、整段(只有 block_id)或整页(None)。"""
|
|
236
|
+
block_id: Optional[str] = None
|
|
237
|
+
end: Optional[str] = None
|
|
238
|
+
quote: Optional[str] = None
|
|
239
|
+
start: Optional[str] = None
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
class AuthConfigBody(BaseModel):
|
|
243
|
+
"""登录方式和站点设置。"""
|
|
244
|
+
allowed_origins: Optional[List[str]] = None
|
|
245
|
+
"""允许跨源嵌入的宿主(`OAD_ALLOWED_ORIGINS`,加上 `OAD_PUBLIC_URL` 的 origin),如 `https://app.example.com`。
|
|
246
|
+
iframe 里的网页只认这些 origin(和同源)发来的 `oad:token`;`/api/v1` 也只对它们回 CORS 头。旧版服务器没有这个字段
|
|
247
|
+
"""
|
|
248
|
+
mode: AuthMode
|
|
249
|
+
"""登录方式:local(账号密码)/ header(宿主反代带身份头)/ none(不登录,单人)/ jwt(宿主签的 JWT)"""
|
|
250
|
+
signup: SignupMode
|
|
251
|
+
timezone: str
|
|
252
|
+
"""服务器的时区(IANA 名字)"""
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
class AuthorRef(BaseModel):
|
|
256
|
+
id: str
|
|
257
|
+
kind: PrincipalKind
|
|
258
|
+
name: str
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
class Authors(BaseModel):
|
|
262
|
+
"""每个 Yjs client id(字符串)是谁写的。"""
|
|
263
|
+
clients: Dict[str, AuthorRef]
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
class BlockBody(BaseModel):
|
|
267
|
+
after: Optional[str] = None
|
|
268
|
+
base: Optional[str] = None
|
|
269
|
+
markdown: str
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
class BlockContent(BaseModel):
|
|
273
|
+
block: DocNode
|
|
274
|
+
markdown: str
|
|
275
|
+
version: str
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
class BlockDiff(BaseModel):
|
|
279
|
+
"""对比里的一块。"""
|
|
280
|
+
after: Optional[str] = None
|
|
281
|
+
before: Optional[str] = None
|
|
282
|
+
by: Optional[List[VersionAuthor]] = None
|
|
283
|
+
"""这块里在两版之间写了字的人"""
|
|
284
|
+
id: str
|
|
285
|
+
op: str
|
|
286
|
+
"""added / removed / changed / same"""
|
|
287
|
+
type: str
|
|
288
|
+
"""块的类型(paragraph、heading…)"""
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
class BlockIds(BaseModel):
|
|
292
|
+
ids: List[str]
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
class CellChange(BaseModel):
|
|
296
|
+
"""一格的改动。"""
|
|
297
|
+
new: Any = None
|
|
298
|
+
old: Any = None
|
|
299
|
+
prop: str
|
|
300
|
+
row_id: str
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
class CellOp(BaseModel):
|
|
304
|
+
"""改一行的几格:值为 null 的清掉。给了 `after` 是挪位置(排在那一行后面,null 是最前面)。"""
|
|
305
|
+
after: Optional[str] = None
|
|
306
|
+
row_id: str
|
|
307
|
+
set: Optional[Dict[str, Any]] = None
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
class CommentCreatedEvent(BaseModel):
|
|
311
|
+
"""SSE 事件 `comment.created` 的 data。"""
|
|
312
|
+
comment_id: Optional[str] = None
|
|
313
|
+
page_id: Optional[str] = None
|
|
314
|
+
thread: Optional[ThreadView] = None
|
|
315
|
+
thread_id: Optional[str] = None
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
class CommentView(BaseModel):
|
|
319
|
+
author: AuthorRef
|
|
320
|
+
body: str
|
|
321
|
+
"""删掉的是空字符串。"""
|
|
322
|
+
created_at: int
|
|
323
|
+
deleted_at: Optional[int] = None
|
|
324
|
+
edited_at: Optional[int] = None
|
|
325
|
+
id: str
|
|
326
|
+
thread_id: str
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
class Content(BaseModel):
|
|
330
|
+
"""正文:`markdown`(默认)、`doc`(`?format=json`)或 `html`(`?format=html`,只读),带当前版本(改的时候作为 base 带回来)。"""
|
|
331
|
+
assets_expire_at: Optional[int] = None
|
|
332
|
+
"""`html` 里图片、文件地址的签名什么时候过期(毫秒时间戳);没有签名地址时是 null。只有 `?format=html` 才有。
|
|
333
|
+
宿主缓存这段 HTML 的话,缓存别超过这个时间(过期前重新取一次)
|
|
334
|
+
"""
|
|
335
|
+
doc: Optional[DocNode] = None
|
|
336
|
+
html: Optional[str] = None
|
|
337
|
+
"""只读 HTML(`?format=html`):外面包 `<div class="oad-content">`,配 `/embed/content.css` 显示。
|
|
338
|
+
只有白名单里的标签和属性;公式、链接卡片是带 `data-*` 的占位;设了 `OAD_PUBLIC_URL` 时文件、页面链接是完整地址。
|
|
339
|
+
调用者看得到的图片、文件地址带签名(`?exp=&sig=`),不登录也打得开,过期时间见 `assets_expire_at`
|
|
340
|
+
"""
|
|
341
|
+
markdown: Optional[str] = None
|
|
342
|
+
total: Optional[int] = None
|
|
343
|
+
"""顶层块一共几个(给了 `limit` 才有)"""
|
|
344
|
+
version: str
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
class CreateAgent(BaseModel):
|
|
348
|
+
about: Optional[str] = None
|
|
349
|
+
"""介绍(给人和别的 Agent 看)"""
|
|
350
|
+
name: str
|
|
351
|
+
"""1 到 40 个字,不能有空白和 @ [ ] ( ) < > 引号 逗号"""
|
|
352
|
+
scope: str
|
|
353
|
+
"""read / write / admin"""
|
|
354
|
+
webhook: Optional[str] = None
|
|
355
|
+
"""收通知的 webhook 地址"""
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
class CreatePage(BaseModel):
|
|
359
|
+
after: Optional[str] = None
|
|
360
|
+
icon: Optional[str] = None
|
|
361
|
+
parent_id: Optional[str] = None
|
|
362
|
+
title: Optional[str] = None
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
class CreatedAgent(BaseModel):
|
|
366
|
+
"""新建的 Agent;token 和 webhook_secret 只有这一次能看到。"""
|
|
367
|
+
agent: Agent
|
|
368
|
+
token: str
|
|
369
|
+
"""`oad_…`,当 Bearer token 用"""
|
|
370
|
+
webhook_secret: str
|
|
371
|
+
"""`whsec_…`,验 webhook 的签名"""
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
class DbChangedEvent(BaseModel):
|
|
375
|
+
"""SSE 事件 `db.changed` 的 data。"""
|
|
376
|
+
db_id: Optional[str] = None
|
|
377
|
+
seq: Optional[int] = None
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
class DbHistory(BaseModel):
|
|
381
|
+
"""库的历史。"""
|
|
382
|
+
items: List[DbHistoryItem]
|
|
383
|
+
"""新的在前;同一次改动(同一个 seq)的格子不会分在两页"""
|
|
384
|
+
next_cursor: Optional[str] = None
|
|
385
|
+
"""还有下一页时给"""
|
|
386
|
+
seq: int
|
|
387
|
+
"""库现在的 seq"""
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
class DbHistoryItem(BaseModel):
|
|
391
|
+
"""历史里的一条。`kind`:`cell`(一格改了)、`row`(加 / 删了一行)、`schema`(表结构改了,只在不按行 / 属性筛时有)。"""
|
|
392
|
+
at: int
|
|
393
|
+
by: Optional[Union[AuthorRef, str]] = None
|
|
394
|
+
cells: Optional[int] = None
|
|
395
|
+
"""schema 有:顺带改了几格"""
|
|
396
|
+
changes: Optional[List[Dict[str, Any]]] = None
|
|
397
|
+
"""schema 有:这次动了哪些属性"""
|
|
398
|
+
kind: str
|
|
399
|
+
"""cell / row / schema"""
|
|
400
|
+
new: Any = None
|
|
401
|
+
old: Any = None
|
|
402
|
+
prop: Optional[str] = None
|
|
403
|
+
"""cell 有:属性的 key"""
|
|
404
|
+
prop_name: Optional[str] = None
|
|
405
|
+
"""cell 有:属性的名字"""
|
|
406
|
+
row_id: Optional[str] = None
|
|
407
|
+
"""cell / row 有"""
|
|
408
|
+
row_title: Optional[str] = None
|
|
409
|
+
"""cell / row 有"""
|
|
410
|
+
seq: int
|
|
411
|
+
summary: Optional[str] = None
|
|
412
|
+
"""row / schema 有:一句话说明"""
|
|
413
|
+
undone: Optional[bool] = None
|
|
414
|
+
"""schema 有:撤销过了"""
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
class DbInfo(BaseModel):
|
|
418
|
+
"""库的信息(GET /databases/{id})。"""
|
|
419
|
+
page: Page
|
|
420
|
+
schema: DbSchema # pyright: ignore[reportIncompatibleMethodOverride, reportIncompatibleVariableOverride]
|
|
421
|
+
seq: int
|
|
422
|
+
views: List[DbView]
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
class DbProp(BaseModel):
|
|
426
|
+
"""一个属性(一列)。`key` 是短随机串,改名不动数据;各类型自己的配置只在那个类型上有。"""
|
|
427
|
+
agent: Optional[str] = None
|
|
428
|
+
"""button 按下时通知的 Agent(id)"""
|
|
429
|
+
comment: Optional[str] = None
|
|
430
|
+
"""button 按下时发的评论"""
|
|
431
|
+
date_format: Optional[str] = None
|
|
432
|
+
"""日期的显示:iso | zh | slash | relative"""
|
|
433
|
+
format: Optional[str] = None
|
|
434
|
+
"""数字的格式:number | comma | percent | cny | usd(number、formula、rollup)"""
|
|
435
|
+
formula: Optional[str] = None
|
|
436
|
+
"""formula 的公式"""
|
|
437
|
+
key: str
|
|
438
|
+
label: Optional[str] = None
|
|
439
|
+
"""button 的文字"""
|
|
440
|
+
name: str
|
|
441
|
+
options: Optional[List[SelectOption]] = None
|
|
442
|
+
"""select / multi_select / status 的选项"""
|
|
443
|
+
precision: Optional[int] = None
|
|
444
|
+
"""显示几位小数"""
|
|
445
|
+
prefix: Optional[str] = None
|
|
446
|
+
"""unique_id 的前缀(T-12)"""
|
|
447
|
+
relation: Optional[RelationConf] = None
|
|
448
|
+
rollup: Optional[RollupConf] = None
|
|
449
|
+
set: Optional[Dict[str, Any]] = None
|
|
450
|
+
"""button 按下时设的值:`{ 属性 key 或名字: 值 }`"""
|
|
451
|
+
type: PropType
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
class DbRow(BaseModel):
|
|
455
|
+
"""库里的一行。`props` 是存的样子(键是属性的 key),标题也在里面(和行页面的标题同步)。"""
|
|
456
|
+
created_at: int
|
|
457
|
+
created_by: Optional[str] = None
|
|
458
|
+
db_id: str
|
|
459
|
+
deleted_at: Optional[int] = None
|
|
460
|
+
id: str
|
|
461
|
+
position: str
|
|
462
|
+
props: Dict[str, Any]
|
|
463
|
+
seq: int
|
|
464
|
+
unique_id: int
|
|
465
|
+
updated_at: int
|
|
466
|
+
updated_by: Optional[str] = None
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
class DbSchema(BaseModel):
|
|
470
|
+
"""表结构。"""
|
|
471
|
+
next_id: Optional[int] = None
|
|
472
|
+
"""下一个自动编号"""
|
|
473
|
+
props: List[DbProp]
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
class DbSchemaEvent(BaseModel):
|
|
477
|
+
"""SSE 事件 `db.schema` 的 data。"""
|
|
478
|
+
db_id: Optional[str] = None
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
class DbSort(BaseModel):
|
|
482
|
+
"""排序:`dir: "asc" | "desc"`。"""
|
|
483
|
+
dir: Optional[str] = None
|
|
484
|
+
prop: str
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
class DbUndone(BaseModel):
|
|
488
|
+
"""撤销的结果:格子改动只有 `seq`;表结构改动还有新的 `schema`、`views`。"""
|
|
489
|
+
schema: Optional[DbSchema] = None # pyright: ignore[reportIncompatibleMethodOverride, reportIncompatibleVariableOverride]
|
|
490
|
+
seq: int
|
|
491
|
+
"""撤销后库的 seq"""
|
|
492
|
+
views: Optional[List[DbView]] = None
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
class DbView(BaseModel):
|
|
496
|
+
"""一个视图。存的时候按表结构清理(去掉指向已删属性的排序、分组、隐藏、列宽)。"""
|
|
497
|
+
calendar_by: Optional[str] = None
|
|
498
|
+
"""日历按哪个日期属性"""
|
|
499
|
+
filter: Optional[Dict[str, Any]] = None
|
|
500
|
+
"""筛选:`{ op: "and" | "or", items: [{ prop, op, value } 或嵌套的组] }`"""
|
|
501
|
+
group_by: Optional[str] = None
|
|
502
|
+
"""按哪个属性分组(看板的列)"""
|
|
503
|
+
group_date: Optional[str] = None
|
|
504
|
+
"""按日期分组时怎么分:day | week | month | year | relative"""
|
|
505
|
+
hidden: Optional[List[str]] = None
|
|
506
|
+
"""隐藏的属性 key"""
|
|
507
|
+
hide_empty_groups: Optional[bool] = None
|
|
508
|
+
"""去掉没有行的分组"""
|
|
509
|
+
id: str
|
|
510
|
+
name: str
|
|
511
|
+
order: Optional[List[str]] = None
|
|
512
|
+
"""列的顺序(属性 key)"""
|
|
513
|
+
sorts: Optional[List[DbSort]] = None
|
|
514
|
+
sub_group_by: Optional[str] = None
|
|
515
|
+
sub_group_date: Optional[str] = None
|
|
516
|
+
totals: Optional[Dict[str, Any]] = None
|
|
517
|
+
"""每列底部的汇总:`{ key: fn }`"""
|
|
518
|
+
type: ViewType
|
|
519
|
+
widths: Optional[Dict[str, Any]] = None
|
|
520
|
+
"""列宽:`{ key: 像素 }`"""
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
class Deleted(BaseModel):
|
|
524
|
+
deleted: List[str]
|
|
525
|
+
"""进了回收站的页面(连子页面)"""
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
class DocMark(BaseModel):
|
|
529
|
+
attrs: Optional[Dict[str, Any]] = None
|
|
530
|
+
"""没有属性时不给"""
|
|
531
|
+
type: str
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
class DocNode(BaseModel):
|
|
535
|
+
"""正文的节点树(和编辑器的 ProseMirror JSON 一样):`{ type, attrs?, content?, text?, marks? }`。"""
|
|
536
|
+
attrs: Optional[Dict[str, Any]] = None
|
|
537
|
+
"""没有属性时不给"""
|
|
538
|
+
content: Optional[List[DocNode]] = None
|
|
539
|
+
marks: Optional[List[DocMark]] = None
|
|
540
|
+
text: Optional[str] = None
|
|
541
|
+
type: str
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
class EditComment(BaseModel):
|
|
545
|
+
body: str
|
|
546
|
+
"""新的正文(Markdown)"""
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
class ErrorBody(BaseModel):
|
|
550
|
+
"""统一的错误:`{ error: { code, message } }`。message 按调用者的语言(中文 / 英文)。"""
|
|
551
|
+
error: ErrorInfo
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
class ErrorInfo(BaseModel):
|
|
555
|
+
code: ErrorCode
|
|
556
|
+
message: str
|
|
557
|
+
"""给人看的原因"""
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
class Ids(BaseModel):
|
|
561
|
+
ids: List[str]
|
|
562
|
+
"""要删的行(进回收站)"""
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
class ImportForm(BaseModel):
|
|
566
|
+
"""multipart 导入的字段。"""
|
|
567
|
+
file: str
|
|
568
|
+
"""CSV 文件(第一行是列名)"""
|
|
569
|
+
parent_id: Optional[str] = None
|
|
570
|
+
"""放在哪个页面下"""
|
|
571
|
+
title: Optional[str] = None
|
|
572
|
+
"""库名"""
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
class Inbox(BaseModel):
|
|
576
|
+
next_cursor: Optional[str] = None
|
|
577
|
+
"""取满了一页时是最后一条(最旧的)的编号,带 `?cursor=` 往旧的翻;没有就是到头了"""
|
|
578
|
+
notifications: List[InboxNotification]
|
|
579
|
+
"""新的在前"""
|
|
580
|
+
unread: int
|
|
581
|
+
"""没读的总数"""
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
class InboxNotification(BaseModel):
|
|
585
|
+
"""收件箱里的一条。"""
|
|
586
|
+
created_at: int
|
|
587
|
+
data: Dict[str, Any]
|
|
588
|
+
"""页面、评论串、谁写的之类(按 type 不同)"""
|
|
589
|
+
id: int
|
|
590
|
+
read_at: Optional[int] = None
|
|
591
|
+
"""没读是 null"""
|
|
592
|
+
type: str
|
|
593
|
+
"""mention / reply / resolved"""
|
|
594
|
+
workspace_id: str
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
class InviteBy(BaseModel):
|
|
598
|
+
name: str
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
class InviteInfo(BaseModel):
|
|
602
|
+
"""邀请链接打开时看到的(不用登录)。"""
|
|
603
|
+
expires_at: Optional[int] = None
|
|
604
|
+
invited_by: Optional[InviteBy] = None
|
|
605
|
+
role: Role
|
|
606
|
+
signup: bool
|
|
607
|
+
"""能不能凭它注册"""
|
|
608
|
+
workspace: InviteWorkspace
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
class InviteList(BaseModel):
|
|
612
|
+
invites: List[InviteView]
|
|
613
|
+
"""还能用的"""
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
class InviteView(BaseModel):
|
|
617
|
+
"""一条邀请链接。"""
|
|
618
|
+
created_at: int
|
|
619
|
+
expires_at: Optional[int] = None
|
|
620
|
+
"""毫秒时间戳;null = 不过期"""
|
|
621
|
+
role: Role
|
|
622
|
+
"""凭它加入后的角色"""
|
|
623
|
+
token: str
|
|
624
|
+
url: str
|
|
625
|
+
"""发给别人的完整链接"""
|
|
626
|
+
uses: int
|
|
627
|
+
"""用过几次"""
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
class InviteWorkspace(BaseModel):
|
|
631
|
+
"""邀请到哪个工作区。"""
|
|
632
|
+
icon: Optional[str] = None
|
|
633
|
+
id: str
|
|
634
|
+
name: str
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
class LoginBody(BaseModel):
|
|
638
|
+
email: str
|
|
639
|
+
password: str
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
class Me(BaseModel):
|
|
643
|
+
"""我是谁、在哪些工作区。"""
|
|
644
|
+
user: MeUser
|
|
645
|
+
workspaces: List[MeWorkspace]
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
class MePatch(BaseModel):
|
|
649
|
+
"""改个人资料:只改给了的字段;给 null 是清掉。"""
|
|
650
|
+
avatar: Optional[str] = None
|
|
651
|
+
"""头像(emoji 或图片地址)"""
|
|
652
|
+
locale: Optional[str] = None
|
|
653
|
+
"""zh / en;null = 跟浏览器"""
|
|
654
|
+
name: Optional[str] = None
|
|
655
|
+
timezone: Optional[str] = None
|
|
656
|
+
"""IANA 时区名;null = 跟服务器"""
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
class MeUser(BaseModel):
|
|
660
|
+
avatar: Optional[str] = None
|
|
661
|
+
email: Optional[str] = None
|
|
662
|
+
id: str
|
|
663
|
+
kind: PrincipalKind
|
|
664
|
+
locale: Optional[str] = None
|
|
665
|
+
"""zh / en / null(跟浏览器)"""
|
|
666
|
+
name: str
|
|
667
|
+
timezone: Optional[str] = None
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
class MeWorkspace(BaseModel):
|
|
671
|
+
icon: Optional[str] = None
|
|
672
|
+
id: str
|
|
673
|
+
name: str
|
|
674
|
+
role: Role
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
class Member(BaseModel):
|
|
678
|
+
role: Role
|
|
679
|
+
user: MemberUser
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
class MemberList(BaseModel):
|
|
683
|
+
"""工作区的人(按加入先后)和 Agent。"""
|
|
684
|
+
agents: List[AgentView]
|
|
685
|
+
members: List[Member]
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
class MemberRole(BaseModel):
|
|
689
|
+
role: Role
|
|
690
|
+
user_id: str
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
class MemberUser(BaseModel):
|
|
694
|
+
avatar: Optional[str] = None
|
|
695
|
+
email: Optional[str] = None
|
|
696
|
+
id: str
|
|
697
|
+
name: str
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
class NewDb(BaseModel):
|
|
701
|
+
"""建库(POST /workspaces/{ws}/databases 的正文)。"""
|
|
702
|
+
after: Optional[str] = None
|
|
703
|
+
"""放在同级里这个页面后面"""
|
|
704
|
+
parent_id: Optional[str] = None
|
|
705
|
+
schema: Optional[Dict[str, Any]] = None # pyright: ignore[reportIncompatibleMethodOverride, reportIncompatibleVariableOverride]
|
|
706
|
+
"""表结构 `{ props: [{ name, type, … }] }`,和 DbSchema 一样,但属性可以不给 key(自动分配),
|
|
707
|
+
选项可以只写名字(`options: ["做", "完"]`)。不给只有标题
|
|
708
|
+
"""
|
|
709
|
+
title: Optional[str] = None
|
|
710
|
+
views: Optional[List[Dict[str, Any]]] = None
|
|
711
|
+
"""视图(和 DbView 一样,id 可以不给);不给是一个表格视图"""
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
class NewInvite(BaseModel):
|
|
715
|
+
expires_in: Optional[int] = None
|
|
716
|
+
"""多少秒后过期;不给 = 不过期"""
|
|
717
|
+
role: str
|
|
718
|
+
"""viewer / editor / admin / owner"""
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
class NewSecret(BaseModel):
|
|
722
|
+
webhook_secret: str
|
|
723
|
+
"""新的 webhook 签名密钥"""
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
class NewThread(BaseModel):
|
|
727
|
+
anchor: Optional[Anchor] = None
|
|
728
|
+
body: str
|
|
729
|
+
"""Markdown;`@[名字](agent:<id>)` / `@[名字](user:<id>)` 或 `@名字` 叫人"""
|
|
730
|
+
notify: Optional[Notify] = None
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
class NewToken(BaseModel):
|
|
734
|
+
token: str
|
|
735
|
+
"""新 token(旧的马上失效)"""
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
class NoteAgent(BaseModel):
|
|
739
|
+
id: str
|
|
740
|
+
name: str
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
class NoteComment(BaseModel):
|
|
744
|
+
author: Dict[str, Any]
|
|
745
|
+
"""`{ kind, id, name }`"""
|
|
746
|
+
body: str
|
|
747
|
+
id: str
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
class NotePage(BaseModel):
|
|
751
|
+
id: str
|
|
752
|
+
title: str
|
|
753
|
+
url: str
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
class Page(BaseModel):
|
|
757
|
+
created_at: int
|
|
758
|
+
created_by: Optional[str] = None
|
|
759
|
+
deleted_at: Optional[int] = None
|
|
760
|
+
icon: Optional[str] = None
|
|
761
|
+
id: str
|
|
762
|
+
kind: Optional[str] = None
|
|
763
|
+
"""page / database / row。"""
|
|
764
|
+
parent_id: Optional[str] = None
|
|
765
|
+
position: str
|
|
766
|
+
title: str
|
|
767
|
+
updated_at: int
|
|
768
|
+
workspace_id: str
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
class PageList(BaseModel):
|
|
772
|
+
pages: List[Page]
|
|
773
|
+
"""不含回收站里的、库里的行;按 (parent_id, position) 排"""
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
class PagePurgedEvent(BaseModel):
|
|
777
|
+
"""SSE 事件 `page.purged` 的 data。"""
|
|
778
|
+
id: Optional[str] = None
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
class PasswordBody(BaseModel):
|
|
782
|
+
current: str
|
|
783
|
+
"""现在的密码"""
|
|
784
|
+
new: str
|
|
785
|
+
"""新密码"""
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
class PatchAgent(BaseModel):
|
|
789
|
+
about: Optional[str] = None
|
|
790
|
+
locale: Optional[str] = None
|
|
791
|
+
"""通知里那段话用的语言:zh / en;null = 跟工作区"""
|
|
792
|
+
name: Optional[str] = None
|
|
793
|
+
scope: Optional[str] = None
|
|
794
|
+
"""read / write / admin"""
|
|
795
|
+
webhook: Optional[str] = None
|
|
796
|
+
"""null = 不用 webhook"""
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
class PatchPage(BaseModel):
|
|
800
|
+
after: Optional[str] = None
|
|
801
|
+
icon: Optional[str] = None
|
|
802
|
+
parent_id: Optional[str] = None
|
|
803
|
+
title: Optional[str] = None
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
class PatchRows(BaseModel):
|
|
807
|
+
ops: List[CellOp]
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
class PatchThread(BaseModel):
|
|
811
|
+
resolved: bool
|
|
812
|
+
"""true = 解决,false = 重新打开"""
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
class Patched(BaseModel):
|
|
816
|
+
"""改了的格子和改完的 seq。"""
|
|
817
|
+
changes: List[CellChange]
|
|
818
|
+
"""真的变了的格子(值没变的不在里面)"""
|
|
819
|
+
seq: int
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
class Pressed(BaseModel):
|
|
823
|
+
"""按按钮的结果。"""
|
|
824
|
+
changes: List[CellChange]
|
|
825
|
+
"""按钮设的属性里真的变了的格子"""
|
|
826
|
+
seq: int
|
|
827
|
+
thread_id: Optional[str] = None
|
|
828
|
+
"""按钮带评论时,发在这一行上的评论串"""
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
class PutContent(BaseModel):
|
|
832
|
+
base: Optional[str] = None
|
|
833
|
+
"""读的时候拿到的版本:在那个版本上改,这期间别人写的不会被覆盖"""
|
|
834
|
+
doc: Optional[DocNode] = None
|
|
835
|
+
markdown: Optional[str] = None
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
class PutShare(BaseModel):
|
|
839
|
+
"""分享设置;不给正文就都是 false。"""
|
|
840
|
+
include_children: Optional[bool] = None
|
|
841
|
+
"""子页面也公开"""
|
|
842
|
+
indexable: Optional[bool] = None
|
|
843
|
+
"""允许搜索引擎收录"""
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
class QueryGroup(BaseModel):
|
|
847
|
+
"""一个分组。空值的分组 `key` 是 "",排在最后。"""
|
|
848
|
+
color: Optional[str] = None
|
|
849
|
+
count: int
|
|
850
|
+
groups: Optional[List[QueryGroup]] = None
|
|
851
|
+
"""子分组(视图有 sub_group_by 时)"""
|
|
852
|
+
ids: List[str]
|
|
853
|
+
key: str
|
|
854
|
+
name: str
|
|
855
|
+
totals: Optional[Dict[str, Any]] = None
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
class QueryReq(BaseModel):
|
|
859
|
+
"""服务器算的查询(给 Agent、给不想加载全部数据的客户端)。给了 view_id 就从那个视图出发,别的字段覆盖它。"""
|
|
860
|
+
filter: Optional[Dict[str, Any]] = None
|
|
861
|
+
"""筛选 `{ op: "and" | "or", items: [...] }`"""
|
|
862
|
+
group_by: Optional[str] = None
|
|
863
|
+
limit: Optional[int] = None
|
|
864
|
+
offset: Optional[int] = None
|
|
865
|
+
search: Optional[str] = None
|
|
866
|
+
sorts: Optional[List[Dict[str, Any]]] = None
|
|
867
|
+
"""排序 `[{ key, dir }]`"""
|
|
868
|
+
totals: Optional[Dict[str, Any]] = None
|
|
869
|
+
"""每列底部的汇总:`{ 属性 key: 汇总方式 }`"""
|
|
870
|
+
view_id: Optional[str] = None
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
class QueryResult(BaseModel):
|
|
874
|
+
"""查询结果。"""
|
|
875
|
+
groups: Optional[List[QueryGroup]] = None
|
|
876
|
+
"""按 group_by 分的组;没分组不给"""
|
|
877
|
+
ids: List[str]
|
|
878
|
+
"""按排序的行 id(给了 limit / offset 是那一段)"""
|
|
879
|
+
rows: List[QueryRow]
|
|
880
|
+
"""这一段的行,带算出来的值"""
|
|
881
|
+
seq: int
|
|
882
|
+
"""库现在的 seq"""
|
|
883
|
+
total: int
|
|
884
|
+
"""符合条件的总行数"""
|
|
885
|
+
totals: Optional[Dict[str, Any]] = None
|
|
886
|
+
"""每列底部的汇总(键是属性的 key);没要不给"""
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
class QueryRow(BaseModel):
|
|
890
|
+
"""查出来的一行:存的样子(`props`,键是属性的 key,空值不存),加上 `computed`(公式、汇总、反向关联算出来的值)。
|
|
891
|
+
和 `DbRow` 不同:不带 `db_id`、`position`(顺序看 `ids`),时间是毫秒数。
|
|
892
|
+
"""
|
|
893
|
+
computed: Dict[str, Any]
|
|
894
|
+
created_at: Optional[float] = None
|
|
895
|
+
"""毫秒时间戳"""
|
|
896
|
+
created_by: Optional[str] = None
|
|
897
|
+
id: str
|
|
898
|
+
props: Dict[str, Any]
|
|
899
|
+
seq: int
|
|
900
|
+
unique_id: Optional[int] = None
|
|
901
|
+
"""自动编号"""
|
|
902
|
+
updated_at: Optional[float] = None
|
|
903
|
+
"""毫秒时间戳"""
|
|
904
|
+
updated_by: Optional[str] = None
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
class ReadCount(BaseModel):
|
|
908
|
+
read: int
|
|
909
|
+
"""标了几条"""
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
class ReadNotes(BaseModel):
|
|
913
|
+
"""标成已读:给 ids,或者 `all: true`。"""
|
|
914
|
+
all: Optional[bool] = None
|
|
915
|
+
"""全部"""
|
|
916
|
+
ids: Optional[List[int]] = None
|
|
917
|
+
"""这些编号"""
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
class RelationConf(BaseModel):
|
|
921
|
+
"""关联:指向哪个库;`mirror_of` 有值时是双向关联的反向那一半。"""
|
|
922
|
+
db_id: str
|
|
923
|
+
mirror_of: Optional[str] = None
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
class Reply(BaseModel):
|
|
927
|
+
body: str
|
|
928
|
+
"""Markdown"""
|
|
929
|
+
notify: Optional[Notify] = None
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
class Restored(BaseModel):
|
|
933
|
+
version: VersionMeta
|
|
934
|
+
"""恢复后新存的一版(kind = restore)"""
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
class RestoredPage(Page):
|
|
938
|
+
"""放回来的那个页面,加上 `restored`(连同放回来的所有页面 id)。"""
|
|
939
|
+
restored: List[str]
|
|
940
|
+
"""放回来的所有页面(这个和一起删的子页面)"""
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
class RoleBody(BaseModel):
|
|
944
|
+
role: str
|
|
945
|
+
"""viewer / editor / admin / owner"""
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
class RollupConf(BaseModel):
|
|
949
|
+
"""汇总:沿关联属性 `relation` 取对方库的属性 `prop`,按 `fn` 归总。"""
|
|
950
|
+
fn: str
|
|
951
|
+
prop: str
|
|
952
|
+
relation: str
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
class RowsDelta(BaseModel):
|
|
956
|
+
"""增量(GET /databases/{id}/rows)。"""
|
|
957
|
+
deleted: List[str]
|
|
958
|
+
rows: List[DbRow]
|
|
959
|
+
seq: int
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
class SaveBody(BaseModel):
|
|
963
|
+
label: Optional[str] = None
|
|
964
|
+
"""这一版的名字"""
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
class SchemaChanged(BaseModel):
|
|
968
|
+
"""改完的表结构。"""
|
|
969
|
+
changes: List[Dict[str, Any]]
|
|
970
|
+
"""动了哪些属性(`{ op, key, name, … }`)"""
|
|
971
|
+
schema: DbSchema # pyright: ignore[reportIncompatibleMethodOverride, reportIncompatibleVariableOverride]
|
|
972
|
+
"""新的表结构"""
|
|
973
|
+
seq: int
|
|
974
|
+
"""这次改动的 seq(历史里撤销用;什么也没变时是现在的 seq)"""
|
|
975
|
+
warnings: Optional[List[str]] = None
|
|
976
|
+
"""改了但有问题的地方(比如公式有错);没有就不给"""
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
class SchemaOps(BaseModel):
|
|
980
|
+
ops: List[Dict[str, Any]]
|
|
981
|
+
"""依次做的改动:`{ op: "add" | "update" | "delete" | "move" | …, … }`,见 docs/phase4-contract.md"""
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
class SchemaUndone(BaseModel):
|
|
985
|
+
"""撤销后的表结构和视图。"""
|
|
986
|
+
schema: DbSchema # pyright: ignore[reportIncompatibleMethodOverride, reportIncompatibleVariableOverride]
|
|
987
|
+
seq: int
|
|
988
|
+
views: List[DbView]
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
class SearchResult(BaseModel):
|
|
992
|
+
"""一条搜索结果(GET /workspaces/{ws}/search)。"""
|
|
993
|
+
block_id: Optional[str] = None
|
|
994
|
+
blocks: int
|
|
995
|
+
"""这个页面命中了几处(标题、正文的段)"""
|
|
996
|
+
db_id: Optional[str] = None
|
|
997
|
+
"""行所在的库"""
|
|
998
|
+
icon: Optional[str] = None
|
|
999
|
+
kind: str
|
|
1000
|
+
"""page / database / row"""
|
|
1001
|
+
page_id: str
|
|
1002
|
+
score: float
|
|
1003
|
+
snippet: str
|
|
1004
|
+
title: str
|
|
1005
|
+
updated_at: int
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
class SearchResults(BaseModel):
|
|
1009
|
+
results: List[SearchResult]
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
class SelectOption(BaseModel):
|
|
1013
|
+
"""选项。status 的有 `group`:todo / doing / done。"""
|
|
1014
|
+
color: str
|
|
1015
|
+
group: Optional[str] = None
|
|
1016
|
+
id: str
|
|
1017
|
+
name: str
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
class Seq(BaseModel):
|
|
1021
|
+
"""改完后库的 seq。"""
|
|
1022
|
+
seq: int
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
class ShareView(BaseModel):
|
|
1026
|
+
"""页面的公开分享链接。"""
|
|
1027
|
+
created_at: int
|
|
1028
|
+
include_children: bool
|
|
1029
|
+
"""子页面也公开"""
|
|
1030
|
+
indexable: bool
|
|
1031
|
+
"""允许搜索引擎收录"""
|
|
1032
|
+
token: str
|
|
1033
|
+
url: str
|
|
1034
|
+
"""公开的网址(`/s/<token>`)"""
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
class SignFileUrls(BaseModel):
|
|
1038
|
+
"""签名地址的请求。"""
|
|
1039
|
+
urls: List[str]
|
|
1040
|
+
"""要签的:文件地址 `/api/v1/files/<id>[/<文件名>]`、转存图片的地址 `/api/v1/media/<hash>`(根相对的或者带域名的,可以带 `?w=`),
|
|
1041
|
+
或者只给文件 id。最多 500 个
|
|
1042
|
+
"""
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
class SignedFileUrls(BaseModel):
|
|
1046
|
+
"""签好的地址。"""
|
|
1047
|
+
expires_at: int
|
|
1048
|
+
"""签名什么时候过期(毫秒时间戳)。有效期是 `OAD_SIGNED_URL_TTL`(默认 24 小时),往后凑整到一个刻度(最多一小时)"""
|
|
1049
|
+
urls: List[Optional[str]]
|
|
1050
|
+
"""和请求的 `urls` 一一对应:原来的地址加上 `exp`、`sig`(只给 id 的是 `/api/v1/files/<id>?exp=…&sig=…`);
|
|
1051
|
+
不是本站的文件、不存在、调用者看不到的是 null
|
|
1052
|
+
"""
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
class SignupBody(BaseModel):
|
|
1056
|
+
email: str
|
|
1057
|
+
invite: Optional[str] = None
|
|
1058
|
+
"""邀请的 token(OAD_SIGNUP=invite 时必须有),注册完直接加入那个工作区"""
|
|
1059
|
+
name: Optional[str] = None
|
|
1060
|
+
"""显示的名字;不给就用邮箱 @ 前面那段"""
|
|
1061
|
+
password: str
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
class ThreadList(BaseModel):
|
|
1065
|
+
threads: List[ThreadView]
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
class ThreadView(BaseModel):
|
|
1069
|
+
anchor: Optional[Anchor] = None
|
|
1070
|
+
comments: List[CommentView]
|
|
1071
|
+
created_at: int
|
|
1072
|
+
created_by: AuthorRef
|
|
1073
|
+
id: str
|
|
1074
|
+
page_id: str
|
|
1075
|
+
resolved_at: Optional[int] = None
|
|
1076
|
+
resolved_by: Optional[AuthorRef] = None
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
class TrashItem(BaseModel):
|
|
1080
|
+
deleted_at: int
|
|
1081
|
+
deleted_by: Optional[AuthorRef] = None
|
|
1082
|
+
icon: Optional[str] = None
|
|
1083
|
+
id: str
|
|
1084
|
+
kind: str
|
|
1085
|
+
parent_id: Optional[str] = None
|
|
1086
|
+
parent_title: Optional[str] = None
|
|
1087
|
+
"""原来在哪个页面下(行是所在的库)"""
|
|
1088
|
+
title: str
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
class TrashList(BaseModel):
|
|
1092
|
+
"""回收站里的页面、库、行(只列单独删的,新删的在前)。"""
|
|
1093
|
+
items: List[TrashItem]
|
|
1094
|
+
next_cursor: Optional[str] = None
|
|
1095
|
+
"""还有下一页时给"""
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
class Undo(BaseModel):
|
|
1099
|
+
seq: int
|
|
1100
|
+
"""要撤销的那次表结构改动"""
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
class UndoBody(BaseModel):
|
|
1104
|
+
seq: int
|
|
1105
|
+
"""要撤销的那次改动(历史里的 seq)"""
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
class UnfurlCard(BaseModel):
|
|
1109
|
+
"""链接卡片。除了 kind / provider / source / url 都可能缺;按 kind 还有别的字段
|
|
1110
|
+
(canonical_url、description、site_name、favicon、author、thumbnail、media、published_at、embed;
|
|
1111
|
+
上传的文件有 name、mime、size、width、height、blurhash、duration_ms;本站的库有 db_id、view_id、icon、views)。
|
|
1112
|
+
"""
|
|
1113
|
+
kind: str
|
|
1114
|
+
"""video / post / repo / issue / pull_request / article / image / file / bookmark / database"""
|
|
1115
|
+
provider: str
|
|
1116
|
+
"""youtube / x / github / bilibili / wechat / generic;上传的文件是 upload,本站的库是 oad"""
|
|
1117
|
+
source: str
|
|
1118
|
+
"""api / syndication / oembed / html / url_only"""
|
|
1119
|
+
stale: Optional[bool] = None
|
|
1120
|
+
"""过期了先给旧的,后台在刷新"""
|
|
1121
|
+
title: Optional[str] = None
|
|
1122
|
+
url: str
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
class UploadForm(BaseModel):
|
|
1126
|
+
"""multipart 上传的表单。"""
|
|
1127
|
+
file: str
|
|
1128
|
+
"""文件(文件名取这个字段的 filename)"""
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
class Uploaded(BaseModel):
|
|
1132
|
+
"""上传接口的返回。"""
|
|
1133
|
+
blurhash: Optional[str] = None
|
|
1134
|
+
duration_ms: Optional[int] = None
|
|
1135
|
+
height: Optional[int] = None
|
|
1136
|
+
id: str
|
|
1137
|
+
mime: str
|
|
1138
|
+
name: str
|
|
1139
|
+
size: int
|
|
1140
|
+
url: str
|
|
1141
|
+
width: Optional[int] = None
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
class VersionAuthor(BaseModel):
|
|
1145
|
+
"""一版里改过的人。"""
|
|
1146
|
+
id: str
|
|
1147
|
+
kind: PrincipalKind
|
|
1148
|
+
name: str
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
class VersionContent(BaseModel):
|
|
1152
|
+
"""某一版的内容。"""
|
|
1153
|
+
doc: DocNode
|
|
1154
|
+
markdown: str
|
|
1155
|
+
version: VersionMeta
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
class VersionDiff(BaseModel):
|
|
1159
|
+
blocks: List[BlockDiff]
|
|
1160
|
+
"""按块的增删改,按新的顺序"""
|
|
1161
|
+
from_: int = Field(alias="from")
|
|
1162
|
+
to: DiffTo
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
class VersionList(BaseModel):
|
|
1166
|
+
"""版本列表,新的在前。"""
|
|
1167
|
+
next_cursor: Optional[str] = None
|
|
1168
|
+
"""还有下一页时给,带上它再取"""
|
|
1169
|
+
versions: List[VersionMeta]
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
class VersionMeta(BaseModel):
|
|
1173
|
+
"""历史版本(不含快照)。kind:auto(停下来 / 改得多了自动存)、agent(Agent 的一次写入)、restore(恢复)、manual(手动存,带名字)。"""
|
|
1174
|
+
authors: List[VersionAuthor]
|
|
1175
|
+
created_at: int
|
|
1176
|
+
created_by: Optional[str] = None
|
|
1177
|
+
id: int
|
|
1178
|
+
kind: str
|
|
1179
|
+
label: Optional[str] = None
|
|
1180
|
+
page_id: str
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
class Views(BaseModel):
|
|
1184
|
+
"""库的全部视图。"""
|
|
1185
|
+
views: List[DbView]
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
class Workspace(BaseModel):
|
|
1189
|
+
created_at: int
|
|
1190
|
+
icon: Optional[str] = None
|
|
1191
|
+
id: str
|
|
1192
|
+
name: str
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
class WsPatch(BaseModel):
|
|
1196
|
+
icon: Optional[str] = None
|
|
1197
|
+
"""图标(emoji 或图片地址);null = 去掉"""
|
|
1198
|
+
name: Optional[str] = None
|
|
1199
|
+
"""新名字"""
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
AuthMode = Union[Literal["local", "header", "none", "jwt"], str]
|
|
1203
|
+
|
|
1204
|
+
DiffTo = Union[int, str]
|
|
1205
|
+
"""对比的另一头:版本号,或 `"current"`。"""
|
|
1206
|
+
|
|
1207
|
+
ErrorCode = Union[Literal["not_found", "bad_request", "unauthorized", "forbidden", "conflict", "gone", "too_large", "too_many_requests", "bad_gateway", "internal"], str]
|
|
1208
|
+
"""错误码:not_found 404、bad_request 400、unauthorized 401、forbidden 403、conflict 409、gone 410(邀请过期之类)、
|
|
1209
|
+
too_large 413、too_many_requests 429(带 Retry-After)、bad_gateway 502(去外部网站取东西失败)、internal 500。
|
|
1210
|
+
"""
|
|
1211
|
+
|
|
1212
|
+
Notify = Union[bool, List[str]]
|
|
1213
|
+
"""评论时叫谁:false = 谁也不叫,`["agent:<id>", ...]` = 只叫这些(不给 / null = 按规则)。"""
|
|
1214
|
+
|
|
1215
|
+
PrincipalKind = Union[Literal["user", "agent"], str]
|
|
1216
|
+
|
|
1217
|
+
PropType = Union[Literal["title", "text", "number", "select", "multi_select", "status", "date", "person", "checkbox", "url", "email", "phone", "files", "created_time", "updated_time", "created_by", "updated_by", "relation", "rollup", "formula", "unique_id", "button"], str]
|
|
1218
|
+
"""属性类型。"""
|
|
1219
|
+
|
|
1220
|
+
ViewObj = Dict[str, Any]
|
|
1221
|
+
"""一个视图(DbView 的样子;id 不给或重复时分配新的,type 不给是 table,name 不给是“视图”)。"""
|
|
1222
|
+
|
|
1223
|
+
PutViews = Union[List[ViewObj], Dict[str, Any]]
|
|
1224
|
+
"""换掉全部视图的正文:视图的数组,或 `{ views: [...] }`。"""
|
|
1225
|
+
|
|
1226
|
+
Role = Union[Literal["viewer", "editor", "admin", "owner"], str]
|
|
1227
|
+
|
|
1228
|
+
Scope = Union[Literal["read", "write", "admin"], str]
|
|
1229
|
+
|
|
1230
|
+
SignupMode = Union[Literal["invite", "open", "off"], str]
|
|
1231
|
+
"""注册方式。"""
|
|
1232
|
+
|
|
1233
|
+
ViewType = Union[Literal["table", "board", "calendar", "gallery", "list"], str]
|
|
1234
|
+
"""视图类型。"""
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
# 工作区事件流里,事件名 → data 的模型(没列的给原始 JSON)
|
|
1238
|
+
EVENT_MODELS: Dict[str, Type[BaseModel]] = {
|
|
1239
|
+
"agent.notification": AgentNotification,
|
|
1240
|
+
"comment.created": CommentCreatedEvent,
|
|
1241
|
+
"db.changed": DbChangedEvent,
|
|
1242
|
+
"db.schema": DbSchemaEvent,
|
|
1243
|
+
"page.created": Page,
|
|
1244
|
+
"page.deleted": Page,
|
|
1245
|
+
"page.moved": Page,
|
|
1246
|
+
"page.purged": PagePurgedEvent,
|
|
1247
|
+
"page.updated": Page,
|
|
1248
|
+
"workspace.updated": Workspace,
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1251
|
+
# 互相引用的、引用后面类型别名的:都定义完了再解析一遍
|
|
1252
|
+
for _m in (
|
|
1253
|
+
Ack,
|
|
1254
|
+
Acked,
|
|
1255
|
+
AddRow,
|
|
1256
|
+
AddRows,
|
|
1257
|
+
AddedRows,
|
|
1258
|
+
Agent,
|
|
1259
|
+
AgentList,
|
|
1260
|
+
AgentNotes,
|
|
1261
|
+
AgentNotification,
|
|
1262
|
+
AgentView,
|
|
1263
|
+
Anchor,
|
|
1264
|
+
AuthConfigBody,
|
|
1265
|
+
AuthorRef,
|
|
1266
|
+
Authors,
|
|
1267
|
+
BlockBody,
|
|
1268
|
+
BlockContent,
|
|
1269
|
+
BlockDiff,
|
|
1270
|
+
BlockIds,
|
|
1271
|
+
CellChange,
|
|
1272
|
+
CellOp,
|
|
1273
|
+
CommentCreatedEvent,
|
|
1274
|
+
CommentView,
|
|
1275
|
+
Content,
|
|
1276
|
+
CreateAgent,
|
|
1277
|
+
CreatePage,
|
|
1278
|
+
CreatedAgent,
|
|
1279
|
+
DbChangedEvent,
|
|
1280
|
+
DbHistory,
|
|
1281
|
+
DbHistoryItem,
|
|
1282
|
+
DbInfo,
|
|
1283
|
+
DbProp,
|
|
1284
|
+
DbRow,
|
|
1285
|
+
DbSchema,
|
|
1286
|
+
DbSchemaEvent,
|
|
1287
|
+
DbSort,
|
|
1288
|
+
DbUndone,
|
|
1289
|
+
DbView,
|
|
1290
|
+
Deleted,
|
|
1291
|
+
DocMark,
|
|
1292
|
+
DocNode,
|
|
1293
|
+
EditComment,
|
|
1294
|
+
ErrorBody,
|
|
1295
|
+
ErrorInfo,
|
|
1296
|
+
Ids,
|
|
1297
|
+
ImportForm,
|
|
1298
|
+
Inbox,
|
|
1299
|
+
InboxNotification,
|
|
1300
|
+
InviteBy,
|
|
1301
|
+
InviteInfo,
|
|
1302
|
+
InviteList,
|
|
1303
|
+
InviteView,
|
|
1304
|
+
InviteWorkspace,
|
|
1305
|
+
LoginBody,
|
|
1306
|
+
Me,
|
|
1307
|
+
MePatch,
|
|
1308
|
+
MeUser,
|
|
1309
|
+
MeWorkspace,
|
|
1310
|
+
Member,
|
|
1311
|
+
MemberList,
|
|
1312
|
+
MemberRole,
|
|
1313
|
+
MemberUser,
|
|
1314
|
+
NewDb,
|
|
1315
|
+
NewInvite,
|
|
1316
|
+
NewSecret,
|
|
1317
|
+
NewThread,
|
|
1318
|
+
NewToken,
|
|
1319
|
+
NoteAgent,
|
|
1320
|
+
NoteComment,
|
|
1321
|
+
NotePage,
|
|
1322
|
+
Page,
|
|
1323
|
+
PageList,
|
|
1324
|
+
PagePurgedEvent,
|
|
1325
|
+
PasswordBody,
|
|
1326
|
+
PatchAgent,
|
|
1327
|
+
PatchPage,
|
|
1328
|
+
PatchRows,
|
|
1329
|
+
PatchThread,
|
|
1330
|
+
Patched,
|
|
1331
|
+
Pressed,
|
|
1332
|
+
PutContent,
|
|
1333
|
+
PutShare,
|
|
1334
|
+
QueryGroup,
|
|
1335
|
+
QueryReq,
|
|
1336
|
+
QueryResult,
|
|
1337
|
+
QueryRow,
|
|
1338
|
+
ReadCount,
|
|
1339
|
+
ReadNotes,
|
|
1340
|
+
RelationConf,
|
|
1341
|
+
Reply,
|
|
1342
|
+
Restored,
|
|
1343
|
+
RestoredPage,
|
|
1344
|
+
RoleBody,
|
|
1345
|
+
RollupConf,
|
|
1346
|
+
RowsDelta,
|
|
1347
|
+
SaveBody,
|
|
1348
|
+
SchemaChanged,
|
|
1349
|
+
SchemaOps,
|
|
1350
|
+
SchemaUndone,
|
|
1351
|
+
SearchResult,
|
|
1352
|
+
SearchResults,
|
|
1353
|
+
SelectOption,
|
|
1354
|
+
Seq,
|
|
1355
|
+
ShareView,
|
|
1356
|
+
SignFileUrls,
|
|
1357
|
+
SignedFileUrls,
|
|
1358
|
+
SignupBody,
|
|
1359
|
+
ThreadList,
|
|
1360
|
+
ThreadView,
|
|
1361
|
+
TrashItem,
|
|
1362
|
+
TrashList,
|
|
1363
|
+
Undo,
|
|
1364
|
+
UndoBody,
|
|
1365
|
+
UnfurlCard,
|
|
1366
|
+
UploadForm,
|
|
1367
|
+
Uploaded,
|
|
1368
|
+
VersionAuthor,
|
|
1369
|
+
VersionContent,
|
|
1370
|
+
VersionDiff,
|
|
1371
|
+
VersionList,
|
|
1372
|
+
VersionMeta,
|
|
1373
|
+
Views,
|
|
1374
|
+
Workspace,
|
|
1375
|
+
WsPatch,
|
|
1376
|
+
):
|
|
1377
|
+
_m.model_rebuild()
|
|
1378
|
+
del _m
|