From 4d9a694d8da7914488d8134438b044b047425ed0 Mon Sep 17 00:00:00 2001 From: riku6460 <17585784+riku6460@users.noreply.github.com> Date: Tue, 26 Sep 2023 05:38:46 +0900 Subject: [PATCH] fix api report --- packages/misskey-js/etc/misskey-js.api.md | 128 +++++++++++++++++++++- 1 file changed, 124 insertions(+), 4 deletions(-) diff --git a/packages/misskey-js/etc/misskey-js.api.md b/packages/misskey-js/etc/misskey-js.api.md index 14352a2473..2c28e7f9a6 100644 --- a/packages/misskey-js/etc/misskey-js.api.md +++ b/packages/misskey-js/etc/misskey-js.api.md @@ -17,6 +17,11 @@ export type Acct = { // @public (undocumented) type Ad = TODO_2; +// @public (undocumented) +type AdminInstanceMetadata = DetailedInstanceMetadata & { + blockedHosts: string[]; +}; + // @public (undocumented) type Announcement = { id: ID; @@ -27,6 +32,7 @@ type Announcement = { imageUrl: string | null; isRead?: boolean; isPrivate: boolean; + closeDuration: number; }; // @public (undocumented) @@ -262,6 +268,9 @@ type CustomEmoji = { url: string; category: string; aliases: string[]; + isSensitive?: boolean; + roleIdsThatCanBeUsedThisEmojiAsReaction?: string[]; + roleIdsThatCanNotBeUsedThisEmojiAsReaction?: string[]; }; // @public (undocumented) @@ -272,6 +281,7 @@ type DetailedInstanceMetadata = LiteInstanceMetadata & { pinnedPages: string[]; pinnedClipId: string | null; cacheRemoteFiles: boolean; + cacheRemoteSensitiveFiles: boolean; requireSetup: boolean; proxyAccountName: string | null; features: Record; @@ -328,6 +338,10 @@ export type Endpoints = { req: TODO; res: TODO; }; + 'admin/meta': { + req: NoParams; + res: AdminInstanceMetadata; + }; 'admin/reset-password': { req: TODO; res: TODO; @@ -424,6 +438,22 @@ export type Endpoints = { req: TODO; res: TODO; }; + 'admin/abuse-report-resolver/create': { + req: TODO; + res: TODO; + }; + 'admin/abuse-report-resolver/list': { + req: TODO; + res: TODO; + }; + 'admin/abuse-report-resolver/update': { + req: TODO; + res: TODO; + }; + 'admin/abuse-report-resolver/delete': { + req: TODO; + res: TODO; + }; 'admin/drive/clean-remote-files': { req: TODO; res: TODO; @@ -482,6 +512,14 @@ export type Endpoints = { req: TODO; res: TODO; }; + 'admin/invite/create': { + req: TODO; + res: TODO; + }; + 'admin/invite/list': { + req: TODO; + res: TODO; + }; 'admin/moderators/add': { req: TODO; res: TODO; @@ -962,8 +1000,14 @@ export type Endpoints = { res: TODO; }; 'drive/files/create': { - req: TODO; - res: TODO; + req: { + folderId?: string; + name?: string; + comment?: string; + isSentisive?: boolean; + force?: boolean; + }; + res: DriveFile; }; 'drive/files/delete': { req: { @@ -1545,6 +1589,28 @@ export type Endpoints = { req: TODO; res: TODO; }; + 'invite/create': { + req: NoParams; + res: Invite; + }; + 'invite/delete': { + req: { + inviteId: Invite['id']; + }; + res: null; + }; + 'invite/list': { + req: { + limit?: number; + sinceId?: Invite['id']; + untilId?: Invite['id']; + }; + res: Invite[]; + }; + 'invite/limit': { + req: NoParams; + res: InviteLimit; + }; 'messaging/history': { req: { limit?: number; @@ -1944,6 +2010,19 @@ export type Endpoints = { req: TODO; res: TODO; }; + 'signup': { + req: { + username: string; + password: string; + host?: string; + invitationCode?: string; + emailAddress?: string; + 'hcaptcha-response'?: string; + 'g-recaptcha-response'?: string; + 'turnstile-response'?: string; + }; + res: MeSignup | null; + }; 'stats': { req: NoParams; res: Stats; @@ -2161,6 +2240,8 @@ declare namespace entities { UserGroup, UserList, MeDetailed, + MeDetailedWithSecret, + MeSignup, DriveFile, DriveFolder, GalleryPost, @@ -2172,6 +2253,7 @@ declare namespace entities { LiteInstanceMetadata, DetailedInstanceMetadata, InstanceMetadata, + AdminInstanceMetadata, ServerInfo, Stats, Page, @@ -2191,6 +2273,8 @@ declare namespace entities { Blocking, Instance, Signin, + Invite, + InviteLimit, UserSorting, OriginType } @@ -2261,7 +2345,7 @@ type ID = string; // @public (undocumented) type Instance = { id: ID; - caughtAt: DateString; + firstRetrievedAt: DateString; host: string; usersCount: number; notesCount: number; @@ -2275,6 +2359,7 @@ type Instance = { lastCommunicatedAt: DateString; isNotResponding: boolean; isSuspended: boolean; + isBlocked: boolean; softwareName: string | null; softwareVersion: string | null; openRegistrations: boolean | null; @@ -2291,6 +2376,23 @@ type Instance = { // @public (undocumented) type InstanceMetadata = LiteInstanceMetadata | DetailedInstanceMetadata; +// @public (undocumented) +type Invite = { + id: ID; + code: string; + expiresAt: DateString | null; + createdAt: DateString; + createdBy: UserLite | null; + usedBy: UserLite | null; + usedAt: DateString | null; + used: boolean; +}; + +// @public (undocumented) +type InviteLimit = { + remaining: number; +}; + // @public (undocumented) function isAPIError(reason: any): reason is APIError; @@ -2363,6 +2465,7 @@ type MeDetailed = UserDetailed & { hasUnreadMessagingMessage: boolean; hasUnreadNotification: boolean; hasUnreadSpecifiedNotes: boolean; + twoFactorBackupCodes: 'full' | 'partial' | 'none'; hideOnlineStatus: boolean; injectFeaturedNote: boolean; integrations: Record; @@ -2376,6 +2479,22 @@ type MeDetailed = UserDetailed & { [other: string]: any; }; +// @public (undocumented) +type MeDetailedWithSecret = MeDetailed & { + email: string; + emailVerified: boolean; + securityKeysList: { + id: string; + name: string; + lastUsed: string; + }[]; +}; + +// @public (undocumented) +type MeSignup = MeDetailedWithSecret & { + token: string; +}; + // @public (undocumented) type MessagingMessage = { id: ID; @@ -2662,6 +2781,7 @@ type UserDetailed = UserLite & { isModerator: boolean; isMuted: boolean; isSilenced: boolean; + isLimited: boolean; isSuspended: boolean; lang: string | null; lastFetchedAt?: DateString; @@ -2721,7 +2841,7 @@ type UserSorting = '+follower' | '-follower' | '+createdAt' | '-createdAt' | '+u // // src/api.types.ts:16:32 - (ae-forgotten-export) The symbol "TODO" needs to be exported by the entry point index.d.ts // src/api.types.ts:18:25 - (ae-forgotten-export) The symbol "NoParams" needs to be exported by the entry point index.d.ts -// src/api.types.ts:596:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts +// src/api.types.ts:633:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts // src/streaming.types.ts:33:4 - (ae-forgotten-export) The symbol "FIXME" needs to be exported by the entry point index.d.ts // (No @packageDocumentation comment for this package)