Пользователи — itd.users

Профили, подписки, блокировки, приватность и значки. Методы принимают UserRef — UUID или имя пользователя, если не указано иное.

Свой профиль

me(): Promise<MyProfile>

Свой профиль — с подпиской и признаком подтверждённого телефона. См. MyProfile.

updateMe(input: UpdateProfileInput): Promise<MyProfile>

Обновляет свой профиль. Передавайте только изменяемые поля.

setBanner(file: FileInput, options?: UploadOptions): Promise<MyProfile>
removeBanner(options?: RequestOptions): Promise<MyProfile>

setBanner() сначала загружает файл через POST /api/files/upload, затем передаёт полученный идентификатор в PUT /api/users/me как { bannerId: file.id }. removeBanner() отправляет в тот же endpoint { bannerId: null }.

import { fromPath } from 'itd-api/node';

await itd.users.setBanner(fromPath('./banner.webp'));
await itd.users.removeBanner();

Метод принимает любую форму вложения: в браузере передайте File, Blob, ArrayBuffer или Uint8Array, а { url } работает везде. Для баннера используйте изображение JPEG, PNG, GIF, WebP, AVIF, HEIC или HEIF. Точный предел размера и разрешения сервером не опубликован, поэтому библиотека не выдумывает ограничение и не отклоняет файл по этим признакам до ответа API.

Если файл уже загружен, второй запрос можно выполнить напрямую:

const file = await itd.files.upload(blob, { filename: 'banner.png' });
await itd.users.updateMe({ bannerId: file.id });

createProfile(input: { username: string; displayName: string; avatar?: string }): Promise<MyProfile>

Создаёт профиль после регистрации.

deactivate(): Promise<void>
restore(): Promise<void>

Деактивирует / восстанавливает аккаунт.

Чужие профили

get(user: UserRef): Promise<PublicProfile>

Профиль пользователя по UUID или имени. См. PublicProfile.

checkUsername(username: string): Promise<boolean>

Свободно ли имя пользователя.

Подписки

follow(user: UserRef): Promise<FollowResult>

Подписывается. У закрытого профиля отправляется заявка — видно по полю status. См. FollowResult.

unfollow(user: UserRef): Promise<void>

Отписывается.

followStatus(userIds: UserId[]): Promise<Record<string, boolean>>

Проверяет подписку сразу для нескольких пользователей. Возвращает «идентификатор → подписаны ли вы».

followers(user: UserRef, params?: UserListParams): Promise<Page<UserSummary>>
iterateFollowers(user: UserRef, params?: UserListParams): Paginator<UserSummary>
following(user: UserRef, params?: UserListParams): Promise<Page<UserSummary>>
iterateFollowing(user: UserRef, params?: UserListParams): Paginator<UserSummary>

Подписчики и подписки. См. UserSummary.

⚠️ Сервер эти списки не листает. Возвращаются первые 20 записей: page игнорируется, limit больше 20 молча уменьшается, hasMore всегда false. Полю total доверять тоже нельзя — оно расходится с followersCount из профиля. Методы-итераторы закончатся после первых 20 записей и оставлены на случай, если пагинацию починят.

Блокировки

block(user: UserRef): Promise<void>
unblock(user: UserRef): Promise<void>

Блокирует / снимает блокировку.

blocked(params?: UserListParams): Promise<Page<UserSummary>>
iterateBlocked(params?: UserListParams): Paginator<UserSummary>

Заблокированные пользователи. Ограничения листания те же, что у followers.

Приватность

getPrivacy(): Promise<PrivacySettings>
updatePrivacy(input: UpdatePrivacyInput): Promise<PrivacySettings>

Читает / обновляет настройки приватности. См. PrivacySettings.

Значки профиля («пины»)

pins(): Promise<PinsResult>

Значки профиля и выбранный из них. activePin — строка-идентификатор, а не объект. См. PinsResult.

setPin(slug: string): Promise<void>
removePin(): Promise<void>

Выбирает / снимает активный значок.

Поиск и рекомендации

Также описаны в разделе Поиск и обнаружение.

search(query: string, params?: { limit?: number }): Promise<UserSummary[]>

Ищет пользователей по строке запроса.

whoToFollow(): Promise<UserSummary[]>

Рекомендации, на кого подписаться.

topClans(): Promise<Clan[]>

Рейтинг кланов. См. Clan.

Типы

interface UpdateProfileInput {
  displayName?: string;
  username?: string;
  avatar?: string;                       // эмодзи-символ клана, а не URL картинки
  bio?: string;
  bannerId?: string | null;              // ID загруженного файла; null удаляет баннер
}

type UpdatePrivacyInput = Partial<PrivacySettings>;

interface UserListParams extends RequestOptions {
  limit?: number;                        // > 20 сервер зажимает до 20
  page?: number;                         // сервер игнорирует
  maxPages?: number;
}