Skip to content

fix: Catch up with the response type from https://scrapbox.io/api/page-data/export/:projectname.json #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 21, 2024
Merged

fix: Catch up with the response type from https://scrapbox.io/api/page-data/export/:projectname.json #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions response.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,16 +301,16 @@ export interface SearchedTitle

/** exportしたときのページデータ */
export interface ExportedPage<hasMetadata extends true | false = false>
extends Pick<Page, "title" | "updated" | "created" | "id"> {
extends Pick<Page, "title" | "updated" | "created" | "id" | "views"> {
/** ページ本文
*
* `hasMetadata === true`のときは行のmetadataが入る
* それ以外の場合は行のテキストが入る
*/
lines: hasMetadata extends true ? Omit<BaseLine, "id" | "userId">[]
: string[];
lines: hasMetadata extends true ? Omit<BaseLine, "id">[] : string[];
}

/** JSON data exported from https://scrapbox.io/api/page-data/export/:projectname.json */
export interface ExportedData<hasMetadata extends true | false = false> {
/** project's name */
name: string;
Expand All @@ -321,10 +321,17 @@ export interface ExportedData<hasMetadata extends true | false = false> {
/** このデータを生成した日時 (UNIX時刻) */
exported: UnixTime;

/** project members */
users: UserForExport[];

/** exported pages */
pages: ExportedPage<hasMetadata>[];
}

/** user infomation included in exported data */
export interface UserForExport
extends Pick<UserInfo, "id" | "name" | "displayName" | "email"> {}

/** backupされるページデータ */
export interface BackupedPage
extends Pick<Page, "title" | "updated" | "created" | "id"> {
Expand Down
Loading