Firefly魔改总结

1
// GET /api/comment?path=...&pageSize=...&page=...&lang=...&sortBy=...
2
// Headers: (token 存在时) Authorization: Bearer <token>
3
// 读取留言列表（分页，首次加载 + 轮询 + 加载历史）
4
getComment({
5
  serverURL: string,     // Waline 服务端地址
6
  lang: string,          // 语言
7
  path: string,          // 页面路径（留言板固定为 /guestbook/）
8
  page: number,          // 页码，从 1 开始
9
  pageSize: number,      // 每页条数
10
  sortBy: string,        // 排序方式（如 "insertedAt_desc"）
11
  token?: string,        // 登录令牌（可选，管理员可看到待审核留言）
12
  signal?: AbortSignal,  // 取消请求信号
13
})
14
// Response: { count: number, page: number, pageSize: number, totalPages: number, data: WalineRootComment[] }
15

16
// --------------------------------------------------------------------------
17

18
// POST /api/comment?lang=<string>
19
// Headers: Content-Type: application/json
20
//         (token 存在时) Authorization: Bearer <token>
21
// Body: { nick, mail?, link?, comment, ua, url, pid?, rid?, at? }
22
// 发布留言
23
addComment({
24
  serverURL: string,
25
  lang: string,
26
  token?: string,           // 登录令牌（登录用户可选，匿名时不需要）
27
  comment: {                // WalineCommentData
28
    nick: string,           // 昵称
29
    mail?: string,          // 邮箱
30
    link?: string,          // 网站地址
31
    comment: string,        // 留言内容（含回复标记 HTML 注释）
32
    ua: string,             // User Agent
33
    url: string,            // 页面路径
34
    pid?: number,           // 父评论 ID（回复时）
35
    rid?: number,           // 根评论 ID（回复时）
36
    at?: string,            // @用户 ID（回复时）
37
  },
38
})
39
// Response: { errno: number, errmsg?: string, data?: WalineComment }
40

41
// --------------------------------------------------------------------------
42

43
// PUT /api/comment/<objectId>?lang=<string>
44
// Headers: Content-Type: application/json
45
//          Authorization: Bearer <token>
46
// Body: { comment?, status?, sticky?, like? }
47
// 编辑留言（仅本人或管理员可编辑）
48
updateComment({
49
  serverURL: string,
50
  lang: string,
51
  token: string,            // 登录令牌（必需）
52
  objectId: number,         // 留言 objectId
53
  comment?: {               // UpdateWalineCommentData
54
    comment?: string,       // 修改后的内容
55
    status?: "approved" | "waiting" | "spam",  // 审核状态（管理员）
56
    sticky?: 0 | 1,         // 置顶状态（管理员）
57
    like?: boolean,         // 点赞/取消点赞
58
  },
59
})
60
// Response: { errno: number, errmsg?: string, data: WalineComment }
61

62
// --------------------------------------------------------------------------
63

64
// DELETE /api/comment/<objectId>?lang=<string>
65
// Headers: Authorization: Bearer <token>
66
// 删除留言（仅本人或管理员可删除）
67
deleteComment({
68
  serverURL: string,
69
  lang: string,
70
  token: string,            // 登录令牌（必需）
71
  objectId: number,         // 留言 objectId
72
})
73
// Response: { errno: number, errmsg: string, data: "" }
74

75
// --------------------------------------------------------------------------
76

77
// GET /api/token?lang=<string>
78
// Headers: Authorization: Bearer <token>
79
// 登录回调 Token 校验（Waline OAuth 重定向回博客后验证身份）
80
fetch(`${serverURL}/api/token?lang=${lang}`, {
81
  headers: { Authorization: `Bearer ${token}` },
82
})
83
// Response: { errno: number, errmsg?: string, data?: UserInfo }

1
// --------------------------------------------------------------------------
2

3
// GET /api/allPostMeta.json
4
// Headers: 无
5
// 调用方：日历小组件客户端脚本（浏览器运行时 fetch）
6
// 构建时由 Astro Content Collections 生成并预渲染为静态 JSON，包含所有文章的元数据
7
fetch("/api/allPostMeta.json")
8
// Response: Array<{ id: string, title: string, published: number, category?: string, password?: boolean }>
9

10
// --------------------------------------------------------------------------
11

12
// GET /api/holidays.json
13
// Headers: 无
14
// 调用方：日历小组件客户端脚本（浏览器运行时 fetch）
15
// 构建时内部调用第三方 API 获取节假日数据后合并内置节日，预渲染为静态 JSON
16
fetch("/api/holidays.json")
17
// Response: Array<{ date: string, name: string, isOfficial?: boolean, isWorkday?: boolean, icon?: string, source: "api" | "builtin", rest?: number }>
18

19
// --------------------------------------------------------------------------
20

21
// GET https://timor.tech/api/holiday/year/<year>
22
// Headers: Accept: application/json
23
// 调用方：/api/holidays.json 内部（构建时由 holidayApi 配置驱动）
24
// 获取中国法定节假日、调休补班日
25
// 配置路径：src/config/calendarConfig.ts → holidayApi.url
26
fetch("https://timor.tech/api/holiday/year/2026")
27
// Response: { code: number, holiday: Record<string, { holiday: boolean, name: string, rest?: number }> }