-
Notifications
You must be signed in to change notification settings - Fork 0
/
global.d.ts
159 lines (136 loc) · 2.99 KB
/
global.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
declare interface ApiReturn<T extends object> {
status: boolean
message: string
data: T
}
declare interface UserInfo {
// 用户名
username: string
}
declare interface Article {
// 文章标题
title: string
// 文章文件名(带 .md)
filename: string
// 文章内容(markdown)
content: string
}
declare interface LoginApi {
// 是否成功
status: boolean
// token
token: string
}
declare interface UserApi {
/**
* 检查登录状态
*/
state: () => Promise<ApiReturn<UserInfo>>
/**
* 登录
* @params baseUrl 请求公共 url,最后不需要 "/"
* @params username 用户名
* @params password 密码 或 Token
*/
login: (baseUrl: string, username: string, password: string) => Promise<ApiReturn<LoginApi>>
}
declare interface AddArticleApi {
// 是否成功
status: boolean
}
declare interface GetArticleApi {
// 是否成功
status: boolean
// 数据
articles: Article[]
}
declare interface UpdateArticleApi {
// 是否成功
status: boolean
}
declare interface DeleteArticleApi {
// 是否成功
status: boolean
}
declare interface PushArticleApi {
// 是否成功
status: boolean
}
declare interface ArticleApi {
/**
* 获取文章列表
*/
get: () => Promise<ApiReturn<GetArticleApi>>
/**
* 添加文章
* @params title 文章标题
* @params filename 文章文件名(带 .md)
* @params content 文章内容(markdown)
*/
add: (title: string, filename: string, content: string) => Promise<ApiReturn<AddArticleApi>>
/**
* 修改文章
* @params filename 文章文件名(带 .md)
* @params content 文章新内容
*/
update: (title: string, filename: string, content: string) => Promise<ApiReturn<UpdateArticleApi>>
/**
* 删除文章
* @params filename 文章文件名(带 .md)
*/
del: (filename: string) => Promise<ApiReturn<DeleteArticleApi>>
/**
* 更新文章
*/
push: () => Promise<ApiReturn<PushArticleApi>>
}
declare interface Image {
id: string
filename: string
url: string
updatedAt: number
}
declare interface UploadImageApi {
// 是否成功
status: boolean
// 路径
urls: string[]
}
declare interface DeleteImageApi {
// 是否成功
status: boolean
}
declare interface GetImageApi {
// 是否成功
status: boolean
// 路径
images: Image[]
}
declare interface ImageApi {
upload: (file: File[]) => Promise<ApiReturn<UploadImageApi>>
del: (id: string) => Promise<ApiReturn<DeleteImageApi>>
get: () => Promise<ApiReturn<GetImageApi>>
}
declare interface ApiConfig {
apiEnv: 'SERVER' | 'GITHUB'
set: (key: string, value: string) => Promise<void>
get: (key: string) => Promise<string | undefined>
}
declare interface API {
config: ApiConfig
user: UserApi
article: ArticleApi
image: ImageApi
}
declare interface GithubImg {
imgApi: string
}
declare interface GithubApi {
apiKey: string
articlesApi: string
imgStorage: 'GITHUB'
githubImg: GithubImg
}
declare interface Window {
API: API
}