From 1e314733f73ab04ef5d0392c6e81d39fdd9fdc00 Mon Sep 17 00:00:00 2001 From: riku6460 <17585784+riku6460@users.noreply.github.com> Date: Wed, 27 Sep 2023 02:10:39 +0900 Subject: [PATCH] fix api report --- packages/misskey-js/etc/misskey-js.api.md | 153 ++++++++++++++++++++-- 1 file changed, 143 insertions(+), 10 deletions(-) diff --git a/packages/misskey-js/etc/misskey-js.api.md b/packages/misskey-js/etc/misskey-js.api.md index 2c28e7f9a6..753411d37a 100644 --- a/packages/misskey-js/etc/misskey-js.api.md +++ b/packages/misskey-js/etc/misskey-js.api.md @@ -12,6 +12,15 @@ export type Acct = { host: string | null; }; +declare namespace acct { + export { + parse, + toString_2 as toString, + Acct + } +} +export { acct } + // Warning: (ae-forgotten-export) The symbol "TODO_2" needs to be exported by the entry point index.d.ts // // @public (undocumented) @@ -20,6 +29,9 @@ type Ad = TODO_2; // @public (undocumented) type AdminInstanceMetadata = DetailedInstanceMetadata & { blockedHosts: string[]; + app192IconUrl: string | null; + app512IconUrl: string | null; + manifestJsonOverride: string; }; // @public (undocumented) @@ -30,9 +42,13 @@ type Announcement = { text: string; title: string; imageUrl: string | null; - isRead?: boolean; - isPrivate: boolean; + display: 'normal' | 'banner' | 'dialog'; + icon: 'info' | 'warning' | 'error' | 'success'; + needConfirmationToRead: boolean; closeDuration: number; + displayOrder: number; + forYou: boolean; + isRead?: boolean; }; // @public (undocumented) @@ -566,11 +582,9 @@ export type Endpoints = { }; 'announcements': { req: { + isActive?: boolean; limit?: number; - withUnreads?: boolean; - sinceId?: Announcement['id']; - untilId?: Announcement['id']; - privateOnly?: boolean; + offset?: number; }; res: Announcement[]; }; @@ -1924,6 +1938,10 @@ export type Endpoints = { }; res: null; }; + 'notifications/test-notification': { + req: NoParams; + res: null; + }; 'notifications/mark-all-as-read': { req: NoParams; res: null; @@ -2190,6 +2208,10 @@ export type Endpoints = { req: TODO; res: TODO; }; + 'users/flashs': { + req: TODO; + res: TODO; + }; 'users/recommendation': { req: TODO; res: TODO; @@ -2276,7 +2298,8 @@ declare namespace entities { Invite, InviteLimit, UserSorting, - OriginType + OriginType, + ModerationLog } } export { entities } @@ -2402,6 +2425,7 @@ type LiteInstanceMetadata = { maintainerEmail: string | null; version: string; name: string | null; + shortName: string | null; uri: string; description: string | null; langs: string[]; @@ -2476,6 +2500,8 @@ type MeDetailed = UserDetailed & { noCrawle: boolean; receiveAnnouncementEmail: boolean; usePasswordLessLogin: boolean; + unreadAnnouncements: Announcement[]; + twoFactorBackupCodesStock: 'full' | 'partial' | 'none'; [other: string]: any; }; @@ -2512,6 +2538,95 @@ type MessagingMessage = { groupId: UserGroup['id'] | null; }; +// @public (undocumented) +type ModerationLog = { + id: ID; + createdAt: DateString; + userId: User['id']; + user: UserDetailed | null; +} & ({ + type: 'updateServerSettings'; + info: ModerationLogPayloads['updateServerSettings']; +} | { + type: 'suspend'; + info: ModerationLogPayloads['suspend']; +} | { + type: 'unsuspend'; + info: ModerationLogPayloads['unsuspend']; +} | { + type: 'updateUserNote'; + info: ModerationLogPayloads['updateUserNote']; +} | { + type: 'addCustomEmoji'; + info: ModerationLogPayloads['addCustomEmoji']; +} | { + type: 'updateCustomEmoji'; + info: ModerationLogPayloads['updateCustomEmoji']; +} | { + type: 'deleteCustomEmoji'; + info: ModerationLogPayloads['deleteCustomEmoji']; +} | { + type: 'assignRole'; + info: ModerationLogPayloads['assignRole']; +} | { + type: 'unassignRole'; + info: ModerationLogPayloads['unassignRole']; +} | { + type: 'updateRole'; + info: ModerationLogPayloads['updateRole']; +} | { + type: 'deleteRole'; + info: ModerationLogPayloads['deleteRole']; +} | { + type: 'clearQueue'; + info: ModerationLogPayloads['clearQueue']; +} | { + type: 'promoteQueue'; + info: ModerationLogPayloads['promoteQueue']; +} | { + type: 'deleteDriveFile'; + info: ModerationLogPayloads['deleteDriveFile']; +} | { + type: 'deleteNote'; + info: ModerationLogPayloads['deleteNote']; +} | { + type: 'createGlobalAnnouncement'; + info: ModerationLogPayloads['createGlobalAnnouncement']; +} | { + type: 'createUserAnnouncement'; + info: ModerationLogPayloads['createUserAnnouncement']; +} | { + type: 'updateGlobalAnnouncement'; + info: ModerationLogPayloads['updateGlobalAnnouncement']; +} | { + type: 'updateUserAnnouncement'; + info: ModerationLogPayloads['updateUserAnnouncement']; +} | { + type: 'deleteGlobalAnnouncement'; + info: ModerationLogPayloads['deleteGlobalAnnouncement']; +} | { + type: 'deleteUserAnnouncement'; + info: ModerationLogPayloads['deleteUserAnnouncement']; +} | { + type: 'resetPassword'; + info: ModerationLogPayloads['resetPassword']; +} | { + type: 'suspendRemoteInstance'; + info: ModerationLogPayloads['suspendRemoteInstance']; +} | { + type: 'unsuspendRemoteInstance'; + info: ModerationLogPayloads['unsuspendRemoteInstance']; +} | { + type: 'markSensitiveDriveFile'; + info: ModerationLogPayloads['markSensitiveDriveFile']; +} | { + type: 'unmarkSensitiveDriveFile'; + info: ModerationLogPayloads['unmarkSensitiveDriveFile']; +}); + +// @public (undocumented) +export const moderationLogTypes: readonly ["updateServerSettings", "suspend", "unsuspend", "updateUserNote", "addCustomEmoji", "updateCustomEmoji", "deleteCustomEmoji", "assignRole", "unassignRole", "updateRole", "deleteRole", "clearQueue", "promoteQueue", "deleteDriveFile", "deleteNote", "createGlobalAnnouncement", "createUserAnnouncement", "updateGlobalAnnouncement", "updateUserAnnouncement", "deleteGlobalAnnouncement", "deleteUserAnnouncement", "resetPassword", "suspendRemoteInstance", "unsuspendRemoteInstance", "markSensitiveDriveFile", "unmarkSensitiveDriveFile"]; + // @public (undocumented) export const mutedNoteReasons: readonly ["word", "manual", "spam", "other"]; @@ -2536,6 +2651,7 @@ type Note = { reactions: Record; renoteCount: number; repliesCount: number; + clippedCount?: number; poll?: { expiresAt: DateString | null; multiple: boolean; @@ -2605,7 +2721,12 @@ type Notification_2 = { userId: User['id']; note: Note; } | { - type: 'pollVote'; + type: 'note'; + user: User; + userId: User['id']; + note: Note; +} | { + type: 'pollEnded'; user: User; userId: User['id']; note: Note; @@ -2631,10 +2752,12 @@ type Notification_2 = { header?: string | null; body: string; icon?: string | null; +} | { + type: 'test'; }); // @public (undocumented) -export const notificationTypes: readonly ["follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app"]; +export const notificationTypes: readonly ["note", "follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app"]; // @public (undocumented) type OriginType = 'combined' | 'local' | 'remote'; @@ -2671,6 +2794,9 @@ type PageEvent = { user: User; }; +// @public (undocumented) +function parse(acct: string): Acct; + // @public (undocumented) export const permissions: string[]; @@ -2749,6 +2875,9 @@ export class Stream extends EventEmitter { useChannel(channel: C, params?: Channels[C]['params'], name?: string): ChannelConnection; } +// @public (undocumented) +function toString_2(acct: Acct): string; + // @public (undocumented) type User = UserLite | UserDetailed; @@ -2766,6 +2895,7 @@ type UserDetailed = UserLite & { name: string; value: string; }[]; + verifiedLinks: string[]; followersCount: number; followingCount: number; hasPendingFollowRequestFromYou: boolean; @@ -2795,9 +2925,11 @@ type UserDetailed = UserLite & { publicReactions: boolean; securityKeys: boolean; twoFactorEnabled: boolean; + usePasswordLessLogin: boolean; updatedAt: DateString | null; uri: string | null; url: string | null; + notify: 'normal' | 'none'; }; // @public (undocumented) @@ -2841,7 +2973,8 @@ 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:633:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts +// src/api.types.ts:635:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts +// src/entities.ts:587:2 - (ae-forgotten-export) The symbol "ModerationLogPayloads" 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)