Skip to content

fix: Update The respones type of /api/pages/:project/:title #81

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
takker99 merged 1 commit into from
Sep 29, 2025
Merged

fix: Update The respones type of /api/pages/:project/:title #81

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
45 changes: 37 additions & 8 deletions api/pages/project/title.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,12 @@ export type TranslationLanguage =
| "UK"
| "ZH";

/** page information */
export interface Page extends BasePage {
/** page information
*
* @typeParam HasInfoboxDefinition Whether the page includes the infobox definition
*/
export interface Page<HasInfoboxDefinition extends boolean = false>
extends BasePage {
/** APIを叩いたuserの最終アクセス日時。
*
* おそらくこの値を元にテロメアの未読/既読の判別をしている
Expand All @@ -158,17 +162,19 @@ export interface Page extends BasePage {
/** ページ内のアイコン */
icons: string[];

helpfeels: string[];

/** ページ内に含まれる、scrapbox.ioにアップロードしたファイルのfile id */
files: string[];

infoboxDefinition: string[];
infoboxDefinition: HasInfoboxDefinition extends true ? [] : string[];

infoboxResult: InfoboxResult[];

infoboxDisableLinks: string[];

/** 関連ページリスト */
relatedPages: RelatedPages;
relatedPages: RelatedPages<HasInfoboxDefinition>;

/** ページを作成したユーザー */
user: User;
Expand All @@ -178,26 +184,49 @@ export interface Page extends BasePage {

/** ページを編集したユーザーのうち、`user`以外の人 */
collaborators: User[];

charsCount: number;

linesCount: number;
}

export interface RelatedPages {
/** A page with infobox definition */
export type PageWithInfoboxDefinition = Page<true>;

/** A page without infobox definition */
export type PageWithoutInfoboxDefinition = Page<false>;

export interface RelatedPages<HasInfoboxDefinition extends boolean = false> {
/** 1 hop links */
links1hop: RelatedPage[];
links1hop:
(HasInfoboxDefinition extends true ? Omit<RelatedPage, "descriptions">
: RelatedPage)[];

/** 2 hop links */
links2hop: RelatedPage[];
links2hop:
(HasInfoboxDefinition extends true ? Omit<RelatedPage, "descriptions">
: RelatedPage)[];

/** external links */
projectLinks1hop: ProjectRelatedPage[];

/** true if there are pages or icons that reference this page */
/** `true` if there are pages or icons that reference this page */
hasBackLinksOrIcons: boolean;

fatHeadwordsLc: string[];

hiddenHeadwordsLc: string[];

/** 2 hop searchのquery */
search: string;

/** 全文検索エンジンの名前 */
searchBackend: string;

charsCount: {
links1hop: number;
links2hop: number;
};
}

export interface InfoboxResult {
Expand Down