Mizah/mizzkey
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

UserDetailed, MeDetailed (#34)

Browse source 
* UserDetailed, MeDetailed

* npm run api

* remote: lastFetchedAt

* Update misskey-js.api.md

Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
This commit is contained in:
Sym 2022-01-01 21:49:31 +09:00 committed by GitHub
parent 755189f6f3
commit 231ac8e323
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2593 additions and 2479 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
etc/misskey-js.api.md
View file

@ -2156,10 +2156,27 @@ type MeDetailed = UserDetailed & {
avatarId: DriveFile['id']; avatarId: DriveFile['id'];
bannerId: DriveFile['id']; bannerId: DriveFile['id'];
autoAcceptFollowed: boolean; autoAcceptFollowed: boolean;
noCrawle: boolean; alwaysMarkNsfw: boolean;
isExplorable: boolean; carefulBot: boolean;
emailNotificationTypes: string[];
hasPendingReceivedFollowRequest: boolean;
hasUnreadAnnouncement: boolean;
hasUnreadAntenna: boolean;
hasUnreadChannel: boolean;
hasUnreadMentions: boolean;
hasUnreadMessagingMessage: boolean;
hasUnreadNotification: boolean;
hasUnreadSpecifiedNotes: boolean;
hideOnlineStatus: boolean; hideOnlineStatus: boolean;
injectFeaturedNote: boolean;
integrations: Record<string, any>;
isDeleted: boolean;
isExplorable: boolean;
mutedWords: string[][]; mutedWords: string[][];
mutingNotificationTypes: string[];
noCrawle: boolean;
receiveAnnouncementEmail: boolean;
usePasswordLessLogin: boolean;
[other: string]: any; [other: string]: any;
}; };
@ -2417,8 +2434,47 @@ type User = UserLite | UserDetailed;
// @public (undocumented) // @public (undocumented)
type UserDetailed = UserLite & { type UserDetailed = UserLite & {
bannerBlurhash: string | null;
bannerColor: string | null;
bannerUrl: string | null;
birthday: string | null;
createdAt: DateString;
description: string | null;
ffVisibility: 'public' | 'followers' | 'private';
fields: {
name: string;
value: string;
}[];
followersCount: number;
followingCount: number;
hasPendingFollowRequestFromYou: boolean;
hasPendingFollowRequestToYou: boolean;
isAdmin: boolean;
isBlocked: boolean;
isBlocking: boolean;
isBot: boolean;
isCat: boolean;
isFollowed: boolean;
isFollowing: boolean;
isLocked: boolean; isLocked: boolean;
isModerator: boolean;
isMuted: boolean;
isSilenced: boolean;
isSuspended: boolean;
lang: string | null;
lastFetchedAt?: DateString;
location: string | null;
notesCount: number;
pinnedNoteIds: ID[];
pinnedNotes: Note[]; pinnedNotes: Note[];
pinnedPage: Page | null;
pinnedPageId: string | null;
publicReactions: boolean;
securityKeys: boolean;
twoFactorEnabled: boolean;
updatedAt: DateString | null;
uri: string | null;
url: string | null;
}; };
// @public (undocumented) // @public (undocumented)

78
src/entities.ts
View file

@ -19,19 +19,54 @@ export type UserLite = {
url: string; url: string;
}[]; }[];
instance?: { instance?: {
name: Instance['name'], name: Instance['name'];
softwareName: Instance['softwareName'], softwareName: Instance['softwareName'];
softwareVersion: Instance['softwareVersion'], softwareVersion: Instance['softwareVersion'];
iconUrl: Instance['iconUrl'], iconUrl: Instance['iconUrl'];
faviconUrl: Instance['faviconUrl'], faviconUrl: Instance['faviconUrl'];
themeColor: Instance['themeColor'], themeColor: Instance['themeColor'];
}; };
}; };
export type UserDetailed = UserLite & { export type UserDetailed = UserLite & {
bannerBlurhash: string | null;
bannerColor: string | null;
bannerUrl: string | null;
birthday: string | null;
createdAt: DateString;
description: string | null;
ffVisibility: 'public' | 'followers' | 'private';
fields: {name: string; value: string}[];
followersCount: number;
followingCount: number;
hasPendingFollowRequestFromYou: boolean;
hasPendingFollowRequestToYou: boolean;
isAdmin: boolean;
isBlocked: boolean;
isBlocking: boolean;
isBot: boolean;
isCat: boolean;
isFollowed: boolean;
isFollowing: boolean;
isLocked: boolean; isLocked: boolean;
isModerator: boolean;
isMuted: boolean;
isSilenced: boolean;
isSuspended: boolean;
lang: string | null;
lastFetchedAt?: DateString;
location: string | null;
notesCount: number;
pinnedNoteIds: ID[];
pinnedNotes: Note[]; pinnedNotes: Note[];
// TODO pinnedPage: Page | null;
pinnedPageId: string | null;
publicReactions: boolean;
securityKeys: boolean;
twoFactorEnabled: boolean;
updatedAt: DateString | null;
uri: string | null;
url: string | null;
}; };
export type UserGroup = TODO; export type UserGroup = TODO;
@ -47,10 +82,27 @@ export type MeDetailed = UserDetailed & {
avatarId: DriveFile['id']; avatarId: DriveFile['id'];
bannerId: DriveFile['id']; bannerId: DriveFile['id'];
autoAcceptFollowed: boolean; autoAcceptFollowed: boolean;
noCrawle: boolean; alwaysMarkNsfw: boolean;
isExplorable: boolean; carefulBot: boolean;
emailNotificationTypes: string[];
hasPendingReceivedFollowRequest: boolean;
hasUnreadAnnouncement: boolean;
hasUnreadAntenna: boolean;
hasUnreadChannel: boolean;
hasUnreadMentions: boolean;
hasUnreadMessagingMessage: boolean;
hasUnreadNotification: boolean;
hasUnreadSpecifiedNotes: boolean;
hideOnlineStatus: boolean; hideOnlineStatus: boolean;
injectFeaturedNote: boolean;
integrations: Record<string, any>;
isDeleted: boolean;
isExplorable: boolean;
mutedWords: string[][]; mutedWords: string[][];
mutingNotificationTypes: string[];
noCrawle: boolean;
receiveAnnouncementEmail: boolean;
usePasswordLessLogin: boolean;
[other: string]: any; [other: string]: any;
}; };
@ -411,5 +463,11 @@ export type Signin = {
success: boolean; success: boolean;
}; };
export type UserSorting = '+follower' | '-follower' | '+createdAt' | '-createdAt' | '+updatedAt' | '-updatedAt'; export type UserSorting =
| '+follower'
| '-follower'
| '+createdAt'
| '-createdAt'
| '+updatedAt'
| '-updatedAt';
export type OriginType = 'combined' | 'local' | 'remote'; export type OriginType = 'combined' | 'local' | 'remote';