-
Notifications
You must be signed in to change notification settings - Fork 2
/
response.ts
422 lines (342 loc) · 9.71 KB
/
response.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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
import {
BaseLine,
BasePage,
PageId,
ProjectId,
StringLc,
UnixTime,
UserId,
} from "./base.ts";
import { Commit } from "./commit.ts";
/** user information */
export interface User {
id: UserId;
/** user name */ name: string;
/** user display name */ displayName: string;
/** profile image URL */ photo: string;
}
/** user detailed information */
export interface UserInfo extends User {
/** user e-mail */ email: string;
/** whether the user is a pro user or not */ pro: boolean;
/** login provider */ provider: "google" | "microsoft" | "email";
/** accountの作成日時 */ created: UnixTime;
/** accountの更新日時 */ updated: UnixTime;
}
/** page information */
export interface Page extends BasePage {
/** APIを叩いたuserの最終アクセス日時。
*
* おそらくこの値を元にテロメアの未読/既読の判別をしている
*/
lastAccessed: UnixTime | null;
/** 生成されたPage historyの数 */
snapshotCount: number;
/** 空リンクだと`false` */
persistent: boolean;
/** ページの行情報 */
lines: BaseLine[];
/** ページ内のリンク */
links: string[];
/** ページ内の外部プロジェクトリンク */
projectLinks: string[];
/** ページ内のアイコン */
icons: string[];
/** ページ内に含まれる、scrapbox.ioにアップロードしたファイルへのリンク */
files: string[];
/** 関連ページリスト */
relatedPages: RelatedPages;
/** 最後にページを更新したユーザー */
user: User;
/** ページを編集したユーザーのうち、`user`以外の人 */
collaborators: User[];
}
export interface RelatedPages {
/** 1 hop links */
links1hop: RelatedPage[];
/** 2 hop links */
links2hop: RelatedPage[];
/** external links */
projectLinks1hop: ProjectRelatedPage[];
/** このページを参照しているページorアイコンがあればtrue */
hasBackLinksOrIcons: boolean;
}
/** 関連ページのメタデータ */
export interface RelatedPage extends
Pick<
BasePage,
| "id"
| "title"
| "image"
| "descriptions"
| "linked"
| "updated"
| "accessed"
> {
/** page title */
titleLc: StringLc;
/**
* links1hopの場合:ページ内の全てのリンク
*
* links2hopの場合:ページ内の全てのリンクのうち、`Page.links`に含まれるリンク
*/
linksLc: StringLc[];
}
/** 外部プロジェクトの関連ページ */
export interface ProjectRelatedPage extends Omit<RelatedPage, "linksLc"> {
/** project name */
projectName: string;
}
/** the response type of https://scrpabox.io/api/pages/:projectname */
export interface PageList {
/** data取得先のproject名 */
projectName: string;
/** parameterに渡したskipと同じ */
skip: number;
/** parameterに渡したlimitと同じ */
limit: number;
/** projectの全ページ数 (中身のないページを除く) */
count: number;
/** 取得できたページ情報 */
pages: BasePage[];
}
/** project information */
export interface Project {
id: ProjectId;
name: string;
displayName: string;
publicVisible: boolean;
loginStrategies: string[];
theme: string;
gyazoTeamsName: string | null;
googleAnalyticsCode: string | null;
/** planの種類
*
* public projectの場合は`null`になる
*
* 古いprojectだとpropertyが生えていない
*/
plan?: string | null;
created: UnixTime;
updated: UnixTime;
isMember: boolean;
}
/** the response type of /api/projects */
export interface ProjectResponse {
projects: Project[];
}
/** project information which isn't joined */
export interface NotMemberProject extends Omit<Project, "isMember"> {
image?: string;
isMember: false;
}
/** project information which is joined */
export interface MemberProject extends Omit<NotMemberProject, "isMember"> {
isMember: true;
plan?: string | null;
users: UserInfo[];
admins: UserId[];
owner: UserId;
trialing: boolean;
trialMaxPages: number;
skipPayment: boolean;
uploadFileTo: "gcs";
uploadImaegTo: "gyazo" | "gcs";
emailAddressPatterns: string[];
backuped: UnixTime | null;
}
export interface GuestUser {
isGuest: true;
csrfToken: string;
}
export interface MemberUser extends UserInfo {
isGuest: false;
csrfToken: string;
config: {
userScript: boolean;
emacsBinding: boolean;
};
}
/** the response type of https://scrapbox.io/api/users/me */
export type UserResponse = GuestUser | MemberUser;
/** the response type of https://scrapbox.io/api/pages/:projectname/search/titles */
export interface SearchedTitle
extends Pick<BasePage, "id" | "title" | "updated"> {
/** thumbnail URL */
image?: string;
/** ページ内のリンク */
links: string[];
}
/** exportしたときのページデータ */
export interface ExportedPage<hasMetadata extends true | false = false>
extends Pick<Page, "title" | "updated" | "created" | "id"> {
/** ページ本文
*
* `hasMetadata === true`のときは行のmetadataが入る
* それ以外の場合は行のテキストが入る
*/
lines: hasMetadata extends true ? Omit<BaseLine, "id" | "userId">[]
: string[];
}
export interface ExportedData<hasMetadata extends true | false = false> {
/** project's name */
name: string;
/** project's display name */
displayName: string;
/** このデータを生成した日時 (UNIX時刻) */
exported: UnixTime;
/** exported pages */
pages: ExportedPage<hasMetadata>[];
}
/** backupされるページデータ */
export interface BackupedPage
extends Pick<Page, "title" | "updated" | "created" | "id"> {
/** ページ本文 */
lines: Pick<BaseLine, "text" | "created" | "updated">[];
/** ページに含まれているリンク*/
linksLc: StringLc[];
}
/** project backup data */
export interface BackupData {
/** project's name */
name: string;
/** project's display name */
displayName: string;
/** このデータを生成した日時 (UNIX時刻) */
exported: UnixTime;
/** backuped pages */
pages: BackupedPage[];
}
/** メタデータ無しインポート用ページデータ */
export interface ImportedLightPage {
/** page's title
*
* `title` should be equal to `lines[0]`
*/
title: string;
/** page's text
*
* `lines[0]` should be equal to `title`
*/
lines: string[];
}
/** インポート用メタデータ付き行データ */
export interface ImportedLine {
/** line text */
text: string;
/** 行の最終更新日時 (UNIX時刻) */
updated?: UnixTime;
/** 行の最終作成日時 (UNIX時刻) */
created?: UnixTime;
}
/** メタデータ付きインポート用ページデータ */
export interface ImportedPage {
/** page's title
*
* `title` should be equal to `lines[0].text`
*/
title: string;
/** page's line data
*
* `lines[0].text` should be equal to `title`
*/
lines: ImportedLine[];
}
/** JSON data for importing by https://scrapbox.io/api/page-data/import/:projectname.json */
export interface ImportedData<hasMetadata extends true | false = false> {
/** pages importing to a project */
pages: hasMetadata extends true ? ImportedPage[] : ImportedLightPage[];
}
/** the response type of /api/embed-text/twitter */
export interface TweetInfo {
/** Tweet本文 */
description: string;
/** Tweet投稿者のuser name*/
userName: string;
/** Tweet投稿者の表示名 */
screenName: string;
/** Tweetに添付された画像 */
images: string[];
}
/** the response type of /api/pages/:projectname/search/titles */
export interface SearchResult {
/** 検索したprojectの名前 */
projectName: string;
/** 検索文字列 */
searchQuery: string;
/** 検索語句 */
query: SearchQuery;
/** 検索件数の上限 */
limit: number;
/** 検索件数 */
count: number;
/** 検索文字列と完全一致するタイトルが見つかったら`true` */
existsExactTitleMatch: boolean;
/** 全文検索エンジンの名前 */
backend: string;
/** 見つかったページ */
pages: {
id: PageId;
/** page title */
title: string;
/** page thumbnail
*
* 無いときは空文字が入る
*/
image: string;
/** 検索語句の中で、このページに含まれている語句 */
words: string[];
/** 検索語句に一致した行
*
* タイトル行のみが一致した場合は、検索語句の有無にかかわらずその次の行のみが入る
*/
lines: string[];
}[];
}
/** the response type of /api/projects/search/query and /api/projects/search/watch-list */
export interface ProjectSearchResult {
/** 検索文字列 */
searchQuery: string;
/** 検索語句 */
query: SearchQuery;
/** 見つかったprojects */
projects: {
_id: ProjectId;
/** project name */
name: string;
/** projectの表示名 */
displayName: string;
/** project favicon
*
* 無いときは`null`が入るかproperty自体が存在しない
*/
image?: string | null;
}[];
}
/** 検索クエリ */
export interface SearchQuery {
/** AND検索に使う語句 */
words: string[];
/** NOT検索に使う語句 */
excludes: string[];
}
/** the response type of /api/commits/:projectname/:pageid */
export interface CommitsResponse {
/** 指定したページのcommits */
commits: Commit[];
}
/** the response type of /api/page-snapshots/:projectname/:pageid */
export interface PageSnapshot {
pageId: PageId;
/** 作成されているsnapshots */
snapshots: Snapshot[];
}
/** a page snapshot */
export interface Snapshot {
/** snapshotを撮ったときのページタイトル */
title: string;
/** snapshotの作成日時 */
created: UnixTime;
/** snapshotしたページ本文 */
lines: BaseLine[];
}