@foxford/sdk 8.0.1 → 8.1.0

package/entities.d.cts

@@ -1,5 +1,13 @@
+import { U as UserInterests } from './types-3Yq2Uj51.cjs';
+import './antibot.cjs';
+import '@foxford/services';
+import '@foxford/types';
+
 type PupilRole = '11 класс' | '10 класс' | '9 класс' | '8 класс' | '7 класс' | '6 класс' | '5 класс' | '4 класс' | '3 класс' | '2 класс' | '1 класс';
 type UserRole = 'Ученик' | 'Репетитор' | 'Учитель' | 'Родитель' | 'Выпускник' | 'Дошкольник' | PupilRole;
+type LeaderboardAccessState = 'unavailable' | 'available' | 'vacation' | 'disabled';
+type LeaderboardReadinessState = 'changeable_course_selection' | 'ready' | 'unready' | 'waiting_course_selection';
+type LearningGoalsAccessState = 'enabled' | 'disabled' | 'optional' | 'required';
 interface UserDTO {
     id: null | number;
     email: string;
@@ -110,79 +118,556 @@ interface UserDTO {
         startsAt: null | string;
         yearName: string;
     } | null;
+    /** Текущий интерес посетителя — та же форма, что у `GET /api/user/user_interest`, но из профиля. */
+    currentInterest: UserInterests | null;
+    /** До какой даты открыт приём в домашнюю школу. */
+    admissionFinishesOn: null | string;
+    /** Посетитель пришёл из Алгоритмики. */
+    algoritmika: boolean;
+    bonusesPageVisited: boolean;
+    canChangeSchoolInfo: boolean;
+    externshipDemoAccessActive: boolean;
+    /** Экстернат ждёт оплаты: когда закроется доступ и по какому договору. */
+    externshipPaymentRequired: {
+        accessClosingDate: string;
+        contractId: number;
+    } | null;
+    externshipPromoHeaderOn: boolean;
+    hasExamProgressAccess: boolean;
+    hasYearlyRecapAccess: boolean;
+    isAttestationSchoolManager: null | boolean;
+    isMentor: boolean;
+    isXpStreakAvailable: boolean;
+    leaderboard: {
+        accessState: LeaderboardAccessState;
+        readinessState: LeaderboardReadinessState;
+    } | null;
+    leaderboardAccessState: LeaderboardAccessState;
+    learningGoalsAccessState: LearningGoalsAccessState;
+    /** Мессенджеры, на которые подписан посетитель; `null` — бэкенд не считал. */
+    messengerSubscriptions: null | string[];
+    needToPromoteRenewalWithCoach: boolean;
+    nextYearCoursesBannerAvailable: boolean;
+    passwordSet: null | boolean;
+    referralCode: null | string;
+    targetActionsOnboardingAvailable: boolean;
 }
 
 declare class User {
     private readonly props;
     private readonly isDefault;
     private constructor();
+    /**
+     * Идентификатор посетителя на бэкенде.
+     *
+     * @returns Число либо `null` у гостя.
+     */
     get id(): UserDTO['id'];
+    /**
+     * Почта посетителя.
+     *
+     * @returns Строка; пустая, если почты нет.
+     */
     get email(): UserDTO['email'];
+    /**
+     * Имя.
+     *
+     * @returns Строка; пустая, если не заполнено.
+     */
     get firstName(): UserDTO['firstName'];
+    /**
+     * Отчество.
+     *
+     * @returns Строка; пустая, если не заполнено.
+     */
     get middleName(): UserDTO['middleName'];
+    /**
+     * Фамилия.
+     *
+     * @returns Строка; пустая, если не заполнено.
+     */
     get lastName(): UserDTO['lastName'];
+    /**
+     * Полное имя, каким его собрал бэкенд.
+     *
+     * @returns Строка; пустая у гостя.
+     */
     get fullName(): UserDTO['fullName'];
+    /**
+     * Короткое имя для обращения в интерфейсе.
+     *
+     * @returns Строка; пустая у гостя.
+     */
     get shortName(): UserDTO['shortName'];
+    /**
+     * Когда заведён профиль.
+     *
+     * @returns Дата ISO либо `null` у гостя.
+     */
     get createdAt(): UserDTO['createdAt'];
+    /**
+     * Часовой пояс посетителя.
+     *
+     * @returns Имя пояса либо `null`, если не задан.
+     */
     get timezone(): UserDTO['timezone'];
+    /**
+     * Локаль интерфейса.
+     *
+     * @returns Код локали либо `null`, если не задана.
+     */
     get locale(): UserDTO['locale'];
+    /**
+     * Класс посетителя: id, порядковый номер, имя и транслит.
+     *
+     * @returns Объект класса; у гостя поля `null` и пустые строки.
+     */
     get grade(): UserDTO['grade'];
+    /**
+     * Телефон посетителя.
+     *
+     * @returns Строка либо `null`, если не указан.
+     */
     get phone(): UserDTO['phone'];
+    /**
+     * Адрес аватара.
+     *
+     * @returns Строка; пустая, если аватара нет.
+     */
     get avatarUrl(): UserDTO['avatarUrl'];
+    /**
+     * Посетитель — родитель.
+     *
+     * @returns `true`, если роль родительская.
+     */
     get isParent(): UserDTO['isParent'];
+    /**
+     * Посетитель — выпускник.
+     *
+     * @returns `true`, если школу закончил.
+     */
     get isGraduated(): UserDTO['isGraduated'];
+    /**
+     * Класс подтверждён посетителем.
+     *
+     * @returns `true`, если класс проверен.
+     */
     get gradeChecked(): UserDTO['gradeChecked'];
+    /**
+     * Тип учётной записи на бэкенде.
+     *
+     * @returns `pupil`, `agent` либо `null` у гостя.
+     */
     get type(): UserDTO['type'];
+    /**
+     * Посетитель — репетитор.
+     *
+     * @returns `true`, если роль репетитора.
+     */
     get isCoach(): UserDTO['isCoach'];
+    /**
+     * Ведёт мини-группы.
+     *
+     * @returns `true`, если ведёт.
+     */
     get isMiniGroupTeacher(): UserDTO['isMiniGroupTeacher'];
+    /**
+     * Репетитор экстерната.
+     *
+     * @returns `true`, если ведёт экстернат.
+     */
     get isExternshipCoach(): UserDTO['isExternshipCoach'];
+    /**
+     * Посетитель — учитель.
+     *
+     * @returns `true`, если роль учителя.
+     */
     get isAgent(): UserDTO['isAgent'];
+    /**
+     * Посетитель — методист.
+     *
+     * @returns `true`, если методист.
+     */
     get methodist(): UserDTO['methodist'];
+    /**
+     * Почтовый адрес: страна, регион, город, улица, дом.
+     *
+     * @returns Объект адреса либо `null`, если не заполнен.
+     */
     get address(): UserDTO['address'];
+    /**
+     * Привязанные соцсети.
+     *
+     * @returns Список провайдеров с идентификаторами; пустой, если привязок нет.
+     */
     get socialNets(): UserDTO['socialNets'];
+    /**
+     * Логин в Skype.
+     *
+     * @returns Строка либо `null`.
+     */
     get skype(): UserDTO['skype'];
+    /**
+     * Настройки интерфейса: показанные подсказки и скрытые баннеры.
+     *
+     * @returns Объект флагов либо `undefined`, если бэкенд их не прислал.
+     */
     get settings(): UserDTO['settings'];
+    /**
+     * Бонусный счёт: подарочные и реальные бонусы.
+     *
+     * @returns Объект с суммами.
+     */
     get bonus(): UserDTO['bonus'];
+    /**
+     * Сумма бонусов на счёте.
+     *
+     * @returns Число.
+     */
     get bonusAmount(): UserDTO['bonusAmount'];
+    /**
+     * Есть действующие покупки.
+     *
+     * @returns `true`, если есть.
+     */
     get hasActivePurchases(): UserDTO['hasActivePurchases'];
+    /**
+     * Остались попытки пробных экзаменов.
+     *
+     * @returns `true`, если остались.
+     */
     get hasAttemptsSolveExamRehearsals(): UserDTO['hasAttemptsSolveExamRehearsals'];
+    /**
+     * Есть закладки.
+     *
+     * @returns `true`, если есть.
+     */
     get hasBookmarks(): UserDTO['hasBookmarks'];
+    /**
+     * Метки посетителя на бэкенде.
+     *
+     * @returns Список строк либо `null`.
+     */
     get tags(): UserDTO['tags'];
+    /**
+     * Шаблон корзины.
+     *
+     * @returns Число либо `null`.
+     */
     get cartTemplateId(): UserDTO['cartTemplateId'];
+    /**
+     * Сколько позиций в корзине.
+     *
+     * @returns Число.
+     */
     get cartItemsCount(): UserDTO['cartItemsCount'];
+    /**
+     * Онбординг пройден.
+     *
+     * @returns `true`, если пройден.
+     */
     get onboardingFinished(): UserDTO['onboardingFinished'];
+    /**
+     * Когда пройден онбординг.
+     *
+     * @returns Дата ISO либо `null`, пока не пройден.
+     */
     get onboardingFinishedAt(): UserDTO['onboardingFinishedAt'];
+    /**
+     * Почта подтверждена.
+     *
+     * @returns `true`, если подтверждена.
+     */
     get emailConfirmed(): UserDTO['emailConfirmed'];
+    /**
+     * Телефон подтверждён.
+     *
+     * @returns `true`, если подтверждён.
+     */
     get phoneConfirmed(): UserDTO['phoneConfirmed'];
+    /**
+     * Почта выдумана бэкендом при регистрации без почты.
+     *
+     * @returns `true`, если почта ненастоящая.
+     */
     get fakeEmail(): UserDTO['fakeEmail'];
+    /**
+     * Посетитель заведён бэкендом без его участия (например, по заявке).
+     *
+     * @returns `true`, если учётная запись ненастоящая.
+     */
     get fakeUser(): UserDTO['fakeUser'];
+    /**
+     * Профиль дополнен данными после регистрации.
+     *
+     * @returns `true`, если дополнен.
+     */
     get profileEnriched(): UserDTO['profileEnriched'];
+    /**
+     * Идентификатор итогов года.
+     *
+     * @returns Строка либо `null`, если итогов нет.
+     */
     get recapUuid(): UserDTO['recapUuid'];
+    /**
+     * Дисциплины, которые изучает посетитель.
+     *
+     * @returns Список id; пустой, если не выбраны.
+     */
     get disciplineIds(): UserDTO['disciplineIds'];
+    /**
+     * Настройки приватности.
+     *
+     * @returns Объект с флагом публичного профиля.
+     */
     get privacy(): UserDTO['privacy'];
+    /**
+     * Телефон родителя.
+     *
+     * @returns Строка либо `null`.
+     */
     get parentPhone(): UserDTO['parentPhone'];
+    /**
+     * Телефон родителя подтверждён.
+     *
+     * @returns `true`, если подтверждён.
+     */
     get parentPhoneConfirmed(): UserDTO['parentPhoneConfirmed'];
+    /**
+     * Посетитель что-то покупал.
+     *
+     * @returns `true`, `false` либо `null`, если бэкенд не считал.
+     */
     get isCustomer(): UserDTO['isCustomer'];
+    /**
+     * Доступны многодневные серии занятий.
+     *
+     * @returns `true`, если доступны.
+     */
     get hasAccessToMultiDaysStreaks(): UserDTO['hasAccessToMultiDaysStreaks'];
+    /**
+     * Ученик начальной школы.
+     *
+     * @returns `true`, если начальная школа.
+     */
     get isElementaryPupil(): UserDTO['isElementaryPupil'];
+    /**
+     * Токен для канала уведомлений по WebSocket.
+     *
+     * @returns Строка либо `null`, если канала нет.
+     */
     get webSocketNotificationsJwt(): UserDTO['webSocketNotificationsJwt'];
+    /**
+     * Доступны аттестационные листы.
+     *
+     * @returns `true`, если доступны.
+     */
     get hasAccessToAttestationSheets(): UserDTO['hasAccessToAttestationSheets'];
+    /**
+     * Посетитель учится в экстернате.
+     *
+     * @returns `true`, если экстернат.
+     */
     get externshipUser(): UserDTO['externshipUser'];
+    /**
+     * Есть оплаченные договоры экстерната.
+     *
+     * @returns `true`, если есть.
+     */
     get hasPurchasedExternshipContracts(): UserDTO['hasPurchasedExternshipContracts'];
+    /**
+     * Доступна аттестация экстерната.
+     *
+     * @returns `true`, если доступна.
+     */
     get hasExternshipAttestationAccess(): UserDTO['hasExternshipAttestationAccess'];
+    /**
+     * Профиль в разделе социализации.
+     *
+     * @returns Объект с id и состоянием либо `null`, если профиля нет.
+     */
     get socializationProfile(): UserDTO['socializationProfile'];
+    /**
+     * Когда заканчивается бесплатный доступ.
+     *
+     * @returns Дата ISO либо `null`, если доступа нет.
+     */
     get freeAccessFinishesAt(): UserDTO['freeAccessFinishesAt'];
+    /**
+     * В комнате начальной школы есть непросмотренные новинки.
+     *
+     * @returns `true`, если есть; `undefined`, если бэкенд не прислал.
+     */
     get hasUnseenRoomFeatures(): UserDTO['hasUnseenRoomFeatures'];
+    /**
+     * Покупал договоры экстерната.
+     *
+     * @returns `true`, если покупал.
+     */
     get purchaseAnyExternshipContracts(): UserDTO['purchaseAnyExternshipContracts'];
+    /**
+     * Связан с экстернатом: ученик, родитель либо репетитор.
+     *
+     * @returns `true`, если связан; `undefined`, если бэкенд не прислал.
+     */
     get hasExternshipRelation(): UserDTO['hasExternshipRelation'];
+    /**
+     * Есть действующий договор экстерната.
+     *
+     * @returns `true`, если есть; `undefined`, если бэкенд не прислал.
+     */
     get hasExternshipActiveContract(): UserDTO['hasExternshipActiveContract'];
+    /**
+     * Можно продлить договор домашней школы.
+     *
+     * @returns `true`, если можно; `undefined`, если бэкенд не прислал.
+     */
     get canProlongateContract(): UserDTO['canProlongateContract'];
+    /**
+     * Окно пролонгации договора: даты, скидка, заголовок следующего года.
+     *
+     * @returns Объект окна, `null` либо `undefined`, если окна нет.
+     */
     get prolongation(): UserDTO['prolongation'];
+    /**
+     * Текущий интерес посетителя: класс, дисциплина, уровень, формат и причина. Та же форма, что у `GET /api/user/user_interest`, но из профиля, без похода.
+     *
+     * @returns Объект интереса либо `null`, если бэкенд не считал.
+     */
+    get currentInterest(): UserDTO['currentInterest'];
+    /**
+     * До какой даты открыт приём в домашнюю школу.
+     *
+     * @returns Дата либо `null`, если приём не идёт.
+     */
+    get admissionFinishesOn(): UserDTO['admissionFinishesOn'];
+    /**
+     * Посетитель пришёл из Алгоритмики — партнёрский вход с другой площадки.
+     *
+     * @returns `true`, если из Алгоритмики.
+     */
+    get algoritmika(): UserDTO['algoritmika'];
+    /**
+     * Страница бонусов уже открывалась — подсказки на ней больше не показываются.
+     *
+     * @returns `true`, если открывалась.
+     */
+    get bonusesPageVisited(): UserDTO['bonusesPageVisited'];
+    /**
+     * Посетителю разрешено менять школу и класс в профиле.
+     *
+     * @returns `true`, если разрешено.
+     */
+    get canChangeSchoolInfo(): UserDTO['canChangeSchoolInfo'];
+    /**
+     * Идёт демо-доступ к экстернату.
+     *
+     * @returns `true`, пока демо активно.
+     */
+    get externshipDemoAccessActive(): UserDTO['externshipDemoAccessActive'];
+    /**
+     * Экстернат ждёт оплаты: когда закроется доступ и по какому договору.
+     *
+     * @returns Объект с датой и id договора либо `null`, если долга нет.
+     */
+    get externshipPaymentRequired(): UserDTO['externshipPaymentRequired'];
+    /**
+     * Показывать промо-шапку экстерната.
+     *
+     * @returns `true`, если показывать.
+     */
+    get externshipPromoHeaderOn(): UserDTO['externshipPromoHeaderOn'];
+    /**
+     * Доступен раздел прогресса подготовки к экзаменам.
+     *
+     * @returns `true`, если доступен.
+     */
+    get hasExamProgressAccess(): UserDTO['hasExamProgressAccess'];
+    /**
+     * Доступны итоги года; их адрес — `recapUuid`.
+     *
+     * @returns `true`, если доступны.
+     */
+    get hasYearlyRecapAccess(): UserDTO['hasYearlyRecapAccess'];
+    /**
+     * Управляет аттестационной школой.
+     *
+     * @returns `true`, `false` либо `null`, если бэкенд не считал.
+     */
+    get isAttestationSchoolManager(): UserDTO['isAttestationSchoolManager'];
+    /**
+     * Посетитель — наставник.
+     *
+     * @returns `true`, если наставник.
+     */
+    get isMentor(): UserDTO['isMentor'];
+    /**
+     * Доступна серия ежедневных занятий с опытом (XP-стрик).
+     *
+     * @returns `true`, если доступна.
+     */
+    get isXpStreakAvailable(): UserDTO['isXpStreakAvailable'];
+    /**
+     * Таблица лидеров: доступна ли посетителю и готов ли он к ней (выбор курса).
+     *
+     * @returns Объект состояний либо `null`, если посетитель вне программы.
+     */
+    get leaderboard(): UserDTO['leaderboard'];
+    /**
+     * Состояние доступа к таблице лидеров.
+     *
+     * @returns `unavailable`, `available`, `vacation` либо `disabled`.
+     */
+    get leaderboardAccessState(): UserDTO['leaderboardAccessState'];
+    /**
+     * Как устроены учебные цели у посетителя.
+     *
+     * @returns `enabled`, `disabled`, `optional` либо `required`.
+     */
+    get learningGoalsAccessState(): UserDTO['learningGoalsAccessState'];
+    /**
+     * Мессенджеры, на которые посетитель подписан на уведомления.
+     *
+     * @returns Список либо `null`, если бэкенд не считал.
+     */
+    get messengerSubscriptions(): UserDTO['messengerSubscriptions'];
+    /**
+     * Пора предлагать продление занятий с репетитором.
+     *
+     * @returns `true`, если пора.
+     */
+    get needToPromoteRenewalWithCoach(): UserDTO['needToPromoteRenewalWithCoach'];
+    /**
+     * Показывать баннер курсов следующего учебного года.
+     *
+     * @returns `true`, если показывать.
+     */
+    get nextYearCoursesBannerAvailable(): UserDTO['nextYearCoursesBannerAvailable'];
+    /**
+     * Пароль задан — вход не только через код или соцсеть.
+     *
+     * @returns `true`, `false` либо `null`, если бэкенд не считал.
+     */
+    get passwordSet(): UserDTO['passwordSet'];
+    /**
+     * Реферальный код для программы «приведи друга».
+     *
+     * @returns Строка либо `null`, если код не выдан.
+     */
+    get referralCode(): UserDTO['referralCode'];
+    /**
+     * Доступен онбординг целевых действий.
+     *
+     * @returns `true`, если доступен.
+     */
+    get targetActionsOnboardingAvailable(): UserDTO['targetActionsOnboardingAvailable'];
     /**
      * Идёт ли сейчас окно пролонгации договора домашней школы.
      *
      * Границы включаются: последний день окна ещё считается пролонгацией. Не заданная граница
      * означает, что окна нет вовсе, а не что оно бесконечно.
+     *
+     * @returns `true`, если сегодня внутри окна включительно
      */
     isProlongationBetweenDates(): boolean;
     /**
@@ -193,11 +678,18 @@ declare class User {
      * @returns клонированный объект
      */
     private static deepClone;
+    /**
+     * Гость — сущность с умолчаниями всех полей и признаком `isDefaultUser()`.
+     *
+     * @returns Новая сущность на каждый вызов: умолчания общие на процесс, копия своя.
+     */
     static createDefault(): User;
     /**
      * Форма посетителя по умолчанию ДАННЫМИ — гость со всеми полями: тому, кто отдаёт `UserDTO`
      * наружу (хост — приложениям), нужна полная форма, а не сущность с методами. Своя копия на
      * вызов: умолчания общие на процесс, и правка чужой копии их не тронет.
+     *
+     * @returns Новая копия умолчаний на каждый вызов
      */
     static defaultDto(): UserDTO;
     /**
@@ -207,6 +699,13 @@ declare class User {
      * @returns санитизированная строка
      */
     private static sanitizeString;
+    /**
+     * Сущность из профиля бэкенда (`UserDTO` в camelCase): строковые поля чистятся от null-байтов
+     * и пробелов по краям, остальное берётся как есть.
+     *
+     * @param input - Профиль в форме `UserDTO`
+     * @returns Сущность над копией профиля: исходный объект не трогается
+     */
     static fromApi(input: unknown): User;
     /**
      * Санитизирует данные пользователя
@@ -215,30 +714,48 @@ declare class User {
      * @returns санитизированные данные
      */
     private static sanitizeUserData;
+    /**
+     * Сущность собрана из умолчаний (`createDefault`), а не из профиля бэкенда.
+     *
+     * @returns `true` у гостя по умолчанию
+     */
     isDefaultUser(): boolean;
+    /**
+     * Посетитель вошёл — у него есть идентификатор на бэкенде.
+     *
+     * @returns `true`, если `id` задан и положителен
+     */
     isLoggedIn(): boolean;
     private static getGradeString;
     /**
-     * Возвращает тектовое представление роли / класса пользователя
+     * Роль либо класс словом — для подписи в интерфейсе.
      *
-     * @returns {UserRole}
+     * @returns «Дошкольник» для нулевого класса, «Выпускник» без класса, иначе класс («5 класс»)
      */
     getPupilRole(): UserRole;
     /**
-     * Возвращает роль пользователя
-     * @returns {UserRole} роль как строка
+     * Роль словом — по флагам профиля, первый совпавший: репетитор, учитель, родитель.
+     *
+     * @returns «Репетитор», «Учитель», «Родитель», иначе роль ученика из `getPupilRole()`
      */
     getRole: () => UserRole;
     /**
-     * Возвращает фамилию и инициалы юзера
-     * @param {User} user
-     * @return {string} 'Пупкин В.'
+     * Фамилия с инициалами имени и отчества — подпись в списках.
+     *
+     * @returns Строка вида «Пупкин В. И.»; без отчества — «Пупкин В.»
      */
     getInitials: () => string;
+    /**
+     * Профиль строкой JSON — для печати в документ и передачи по сети.
+     *
+     * @returns JSON полей сущности
+     */
     toJson(): string;
     /**
      * Посетитель данными — то, что едет по сети и в состояние: сущность с методами не
      * сериализуется. Своя копия на вызов: сущность неизменяема, и правка копии её не тронет.
+     *
+     * @returns Копия полей сущности данными
      */
     toDto(): UserDTO;
 }