@foxford/sdk 8.0.1 → 8.1.1

package/entities.js.flow

@@ -1,4 +1,7 @@
 // @flow
+import { U as UserInterests } from "./types-BrKJGAOa.js";
+import "./antibot.js";
+
 declare type PupilRole =
   | "11 класс"
   | "10 класс"
@@ -19,6 +22,21 @@ declare type UserRole =
   | "Выпускник"
   | "Дошкольник"
   | PupilRole;
+declare type LeaderboardAccessState =
+  | "unavailable"
+  | "available"
+  | "vacation"
+  | "disabled";
+declare type LeaderboardReadinessState =
+  | "changeable_course_selection"
+  | "ready"
+  | "unready"
+  | "waiting_course_selection";
+declare type LearningGoalsAccessState =
+  | "enabled"
+  | "disabled"
+  | "optional"
+  | "required";
 declare interface UserDTO {
   id: null | number;
   email: string;
@@ -146,138 +164,677 @@ declare interface UserDTO {
     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 {
   constructor(): this;
+
+  /**
+   * Идентификатор посетителя на бэкенде.
+   * @returns Число либо `null` у гостя.
+   */
   id: $PropertyType<UserDTO, "id">;
+
+  /**
+   * Почта посетителя.
+   * @returns Строка; пустая, если почты нет.
+   */
   email: $PropertyType<UserDTO, "email">;
+
+  /**
+   * Имя.
+   * @returns Строка; пустая, если не заполнено.
+   */
   firstName: $PropertyType<UserDTO, "firstName">;
+
+  /**
+   * Отчество.
+   * @returns Строка; пустая, если не заполнено.
+   */
   middleName: $PropertyType<UserDTO, "middleName">;
+
+  /**
+   * Фамилия.
+   * @returns Строка; пустая, если не заполнено.
+   */
   lastName: $PropertyType<UserDTO, "lastName">;
+
+  /**
+   * Полное имя, каким его собрал бэкенд.
+   * @returns Строка; пустая у гостя.
+   */
   fullName: $PropertyType<UserDTO, "fullName">;
+
+  /**
+   * Короткое имя для обращения в интерфейсе.
+   * @returns Строка; пустая у гостя.
+   */
   shortName: $PropertyType<UserDTO, "shortName">;
+
+  /**
+   * Когда заведён профиль.
+   * @returns Дата ISO либо `null` у гостя.
+   */
   createdAt: $PropertyType<UserDTO, "createdAt">;
+
+  /**
+   * Часовой пояс посетителя.
+   * @returns Имя пояса либо `null`, если не задан.
+   */
   timezone: $PropertyType<UserDTO, "timezone">;
+
+  /**
+   * Локаль интерфейса.
+   * @returns Код локали либо `null`, если не задана.
+   */
   locale: $PropertyType<UserDTO, "locale">;
+
+  /**
+   * Класс посетителя: id, порядковый номер, имя и транслит.
+   * @returns Объект класса; у гостя поля `null` и пустые строки.
+   */
   grade: $PropertyType<UserDTO, "grade">;
+
+  /**
+   * Телефон посетителя.
+   * @returns Строка либо `null`, если не указан.
+   */
   phone: $PropertyType<UserDTO, "phone">;
+
+  /**
+   * Адрес аватара.
+   * @returns Строка; пустая, если аватара нет.
+   */
   avatarUrl: $PropertyType<UserDTO, "avatarUrl">;
+
+  /**
+   * Посетитель — родитель.
+   * @returns `true`, если роль родительская.
+   */
   isParent: $PropertyType<UserDTO, "isParent">;
+
+  /**
+   * Посетитель — выпускник.
+   * @returns `true`, если школу закончил.
+   */
   isGraduated: $PropertyType<UserDTO, "isGraduated">;
+
+  /**
+   * Класс подтверждён посетителем.
+   * @returns `true`, если класс проверен.
+   */
   gradeChecked: $PropertyType<UserDTO, "gradeChecked">;
+
+  /**
+   * Тип учётной записи на бэкенде.
+   * @returns `pupil`, `agent` либо `null` у гостя.
+   */
   type: $PropertyType<UserDTO, "type">;
+
+  /**
+   * Посетитель — репетитор.
+   * @returns `true`, если роль репетитора.
+   */
   isCoach: $PropertyType<UserDTO, "isCoach">;
+
+  /**
+   * Ведёт мини-группы.
+   * @returns `true`, если ведёт.
+   */
   isMiniGroupTeacher: $PropertyType<UserDTO, "isMiniGroupTeacher">;
+
+  /**
+   * Репетитор экстерната.
+   * @returns `true`, если ведёт экстернат.
+   */
   isExternshipCoach: $PropertyType<UserDTO, "isExternshipCoach">;
+
+  /**
+   * Посетитель — учитель.
+   * @returns `true`, если роль учителя.
+   */
   isAgent: $PropertyType<UserDTO, "isAgent">;
+
+  /**
+   * Посетитель — методист.
+   * @returns `true`, если методист.
+   */
   methodist: $PropertyType<UserDTO, "methodist">;
+
+  /**
+   * Почтовый адрес: страна, регион, город, улица, дом.
+   * @returns Объект адреса либо `null`, если не заполнен.
+   */
   address: $PropertyType<UserDTO, "address">;
+
+  /**
+   * Привязанные соцсети.
+   * @returns Список провайдеров с идентификаторами; пустой, если привязок нет.
+   */
   socialNets: $PropertyType<UserDTO, "socialNets">;
+
+  /**
+   * Логин в Skype.
+   * @returns Строка либо `null`.
+   */
   skype: $PropertyType<UserDTO, "skype">;
+
+  /**
+   * Настройки интерфейса: показанные подсказки и скрытые баннеры.
+   * @returns Объект флагов либо `undefined`, если бэкенд их не прислал.
+   */
   settings: $PropertyType<UserDTO, "settings">;
+
+  /**
+   * Бонусный счёт: подарочные и реальные бонусы.
+   * @returns Объект с суммами.
+   */
   bonus: $PropertyType<UserDTO, "bonus">;
+
+  /**
+   * Сумма бонусов на счёте.
+   * @returns Число.
+   */
   bonusAmount: $PropertyType<UserDTO, "bonusAmount">;
+
+  /**
+   * Есть действующие покупки.
+   * @returns `true`, если есть.
+   */
   hasActivePurchases: $PropertyType<UserDTO, "hasActivePurchases">;
+
+  /**
+   * Остались попытки пробных экзаменов.
+   * @returns `true`, если остались.
+   */
   hasAttemptsSolveExamRehearsals: $PropertyType<
     UserDTO,
     "hasAttemptsSolveExamRehearsals"
   >;
+
+  /**
+   * Есть закладки.
+   * @returns `true`, если есть.
+   */
   hasBookmarks: $PropertyType<UserDTO, "hasBookmarks">;
+
+  /**
+   * Метки посетителя на бэкенде.
+   * @returns Список строк либо `null`.
+   */
   tags: $PropertyType<UserDTO, "tags">;
+
+  /**
+   * Шаблон корзины.
+   * @returns Число либо `null`.
+   */
   cartTemplateId: $PropertyType<UserDTO, "cartTemplateId">;
+
+  /**
+   * Сколько позиций в корзине.
+   * @returns Число.
+   */
   cartItemsCount: $PropertyType<UserDTO, "cartItemsCount">;
+
+  /**
+   * Онбординг пройден.
+   * @returns `true`, если пройден.
+   */
   onboardingFinished: $PropertyType<UserDTO, "onboardingFinished">;
+
+  /**
+   * Когда пройден онбординг.
+   * @returns Дата ISO либо `null`, пока не пройден.
+   */
   onboardingFinishedAt: $PropertyType<UserDTO, "onboardingFinishedAt">;
+
+  /**
+   * Почта подтверждена.
+   * @returns `true`, если подтверждена.
+   */
   emailConfirmed: $PropertyType<UserDTO, "emailConfirmed">;
+
+  /**
+   * Телефон подтверждён.
+   * @returns `true`, если подтверждён.
+   */
   phoneConfirmed: $PropertyType<UserDTO, "phoneConfirmed">;
+
+  /**
+   * Почта выдумана бэкендом при регистрации без почты.
+   * @returns `true`, если почта ненастоящая.
+   */
   fakeEmail: $PropertyType<UserDTO, "fakeEmail">;
+
+  /**
+   * Посетитель заведён бэкендом без его участия (например, по заявке).
+   * @returns `true`, если учётная запись ненастоящая.
+   */
   fakeUser: $PropertyType<UserDTO, "fakeUser">;
+
+  /**
+   * Профиль дополнен данными после регистрации.
+   * @returns `true`, если дополнен.
+   */
   profileEnriched: $PropertyType<UserDTO, "profileEnriched">;
+
+  /**
+   * Идентификатор итогов года.
+   * @returns Строка либо `null`, если итогов нет.
+   */
   recapUuid: $PropertyType<UserDTO, "recapUuid">;
+
+  /**
+   * Дисциплины, которые изучает посетитель.
+   * @returns Список id; пустой, если не выбраны.
+   */
   disciplineIds: $PropertyType<UserDTO, "disciplineIds">;
+
+  /**
+   * Настройки приватности.
+   * @returns Объект с флагом публичного профиля.
+   */
   privacy: $PropertyType<UserDTO, "privacy">;
+
+  /**
+   * Телефон родителя.
+   * @returns Строка либо `null`.
+   */
   parentPhone: $PropertyType<UserDTO, "parentPhone">;
+
+  /**
+   * Телефон родителя подтверждён.
+   * @returns `true`, если подтверждён.
+   */
   parentPhoneConfirmed: $PropertyType<UserDTO, "parentPhoneConfirmed">;
+
+  /**
+   * Посетитель что-то покупал.
+   * @returns `true`, `false` либо `null`, если бэкенд не считал.
+   */
   isCustomer: $PropertyType<UserDTO, "isCustomer">;
+
+  /**
+   * Доступны многодневные серии занятий.
+   * @returns `true`, если доступны.
+   */
   hasAccessToMultiDaysStreaks: $PropertyType<
     UserDTO,
     "hasAccessToMultiDaysStreaks"
   >;
+
+  /**
+   * Ученик начальной школы.
+   * @returns `true`, если начальная школа.
+   */
   isElementaryPupil: $PropertyType<UserDTO, "isElementaryPupil">;
+
+  /**
+   * Токен для канала уведомлений по WebSocket.
+   * @returns Строка либо `null`, если канала нет.
+   */
   webSocketNotificationsJwt: $PropertyType<
     UserDTO,
     "webSocketNotificationsJwt"
   >;
+
+  /**
+   * Доступны аттестационные листы.
+   * @returns `true`, если доступны.
+   */
   hasAccessToAttestationSheets: $PropertyType<
     UserDTO,
     "hasAccessToAttestationSheets"
   >;
+
+  /**
+   * Посетитель учится в экстернате.
+   * @returns `true`, если экстернат.
+   */
   externshipUser: $PropertyType<UserDTO, "externshipUser">;
+
+  /**
+   * Есть оплаченные договоры экстерната.
+   * @returns `true`, если есть.
+   */
   hasPurchasedExternshipContracts: $PropertyType<
     UserDTO,
     "hasPurchasedExternshipContracts"
   >;
+
+  /**
+   * Доступна аттестация экстерната.
+   * @returns `true`, если доступна.
+   */
   hasExternshipAttestationAccess: $PropertyType<
     UserDTO,
     "hasExternshipAttestationAccess"
   >;
+
+  /**
+   * Профиль в разделе социализации.
+   * @returns Объект с id и состоянием либо `null`, если профиля нет.
+   */
   socializationProfile: $PropertyType<UserDTO, "socializationProfile">;
+
+  /**
+   * Когда заканчивается бесплатный доступ.
+   * @returns Дата ISO либо `null`, если доступа нет.
+   */
   freeAccessFinishesAt: $PropertyType<UserDTO, "freeAccessFinishesAt">;
+
+  /**
+   * В комнате начальной школы есть непросмотренные новинки.
+   * @returns `true`, если есть; `undefined`, если бэкенд не прислал.
+   */
   hasUnseenRoomFeatures: $PropertyType<UserDTO, "hasUnseenRoomFeatures">;
+
+  /**
+   * Покупал договоры экстерната.
+   * @returns `true`, если покупал.
+   */
   purchaseAnyExternshipContracts: $PropertyType<
     UserDTO,
     "purchaseAnyExternshipContracts"
   >;
+
+  /**
+   * Связан с экстернатом: ученик, родитель либо репетитор.
+   * @returns `true`, если связан; `undefined`, если бэкенд не прислал.
+   */
   hasExternshipRelation: $PropertyType<UserDTO, "hasExternshipRelation">;
+
+  /**
+   * Есть действующий договор экстерната.
+   * @returns `true`, если есть; `undefined`, если бэкенд не прислал.
+   */
   hasExternshipActiveContract: $PropertyType<
     UserDTO,
     "hasExternshipActiveContract"
   >;
+
+  /**
+   * Можно продлить договор домашней школы.
+   * @returns `true`, если можно; `undefined`, если бэкенд не прислал.
+   */
   canProlongateContract: $PropertyType<UserDTO, "canProlongateContract">;
+
+  /**
+   * Окно пролонгации договора: даты, скидка, заголовок следующего года.
+   * @returns Объект окна, `null` либо `undefined`, если окна нет.
+   */
   prolongation: $PropertyType<UserDTO, "prolongation">;
 
+  /**
+   * Текущий интерес посетителя: класс, дисциплина, уровень, формат и причина. Та же форма, что у `GET /api/user/user_interest`, но из профиля, без похода.
+   * @returns Объект интереса либо `null`, если бэкенд не считал.
+   */
+  currentInterest: $PropertyType<UserDTO, "currentInterest">;
+
+  /**
+   * До какой даты открыт приём в домашнюю школу.
+   * @returns Дата либо `null`, если приём не идёт.
+   */
+  admissionFinishesOn: $PropertyType<UserDTO, "admissionFinishesOn">;
+
+  /**
+   * Посетитель пришёл из Алгоритмики — партнёрский вход с другой площадки.
+   * @returns `true`, если из Алгоритмики.
+   */
+  algoritmika: $PropertyType<UserDTO, "algoritmika">;
+
+  /**
+   * Страница бонусов уже открывалась — подсказки на ней больше не показываются.
+   * @returns `true`, если открывалась.
+   */
+  bonusesPageVisited: $PropertyType<UserDTO, "bonusesPageVisited">;
+
+  /**
+   * Посетителю разрешено менять школу и класс в профиле.
+   * @returns `true`, если разрешено.
+   */
+  canChangeSchoolInfo: $PropertyType<UserDTO, "canChangeSchoolInfo">;
+
+  /**
+   * Идёт демо-доступ к экстернату.
+   * @returns `true`, пока демо активно.
+   */
+  externshipDemoAccessActive: $PropertyType<
+    UserDTO,
+    "externshipDemoAccessActive"
+  >;
+
+  /**
+   * Экстернат ждёт оплаты: когда закроется доступ и по какому договору.
+   * @returns Объект с датой и id договора либо `null`, если долга нет.
+   */
+  externshipPaymentRequired: $PropertyType<
+    UserDTO,
+    "externshipPaymentRequired"
+  >;
+
+  /**
+   * Показывать промо-шапку экстерната.
+   * @returns `true`, если показывать.
+   */
+  externshipPromoHeaderOn: $PropertyType<UserDTO, "externshipPromoHeaderOn">;
+
+  /**
+   * Доступен раздел прогресса подготовки к экзаменам.
+   * @returns `true`, если доступен.
+   */
+  hasExamProgressAccess: $PropertyType<UserDTO, "hasExamProgressAccess">;
+
+  /**
+   * Доступны итоги года; их адрес — `recapUuid`.
+   * @returns `true`, если доступны.
+   */
+  hasYearlyRecapAccess: $PropertyType<UserDTO, "hasYearlyRecapAccess">;
+
+  /**
+   * Управляет аттестационной школой.
+   * @returns `true`, `false` либо `null`, если бэкенд не считал.
+   */
+  isAttestationSchoolManager: $PropertyType<
+    UserDTO,
+    "isAttestationSchoolManager"
+  >;
+
+  /**
+   * Посетитель — наставник.
+   * @returns `true`, если наставник.
+   */
+  isMentor: $PropertyType<UserDTO, "isMentor">;
+
+  /**
+   * Доступна серия ежедневных занятий с опытом (XP-стрик).
+   * @returns `true`, если доступна.
+   */
+  isXpStreakAvailable: $PropertyType<UserDTO, "isXpStreakAvailable">;
+
+  /**
+   * Таблица лидеров: доступна ли посетителю и готов ли он к ней (выбор курса).
+   * @returns Объект состояний либо `null`, если посетитель вне программы.
+   */
+  leaderboard: $PropertyType<UserDTO, "leaderboard">;
+
+  /**
+   * Состояние доступа к таблице лидеров.
+   * @returns `unavailable`, `available`, `vacation` либо `disabled`.
+   */
+  leaderboardAccessState: $PropertyType<UserDTO, "leaderboardAccessState">;
+
+  /**
+   * Как устроены учебные цели у посетителя.
+   * @returns `enabled`, `disabled`, `optional` либо `required`.
+   */
+  learningGoalsAccessState: $PropertyType<UserDTO, "learningGoalsAccessState">;
+
+  /**
+   * Мессенджеры, на которые посетитель подписан на уведомления.
+   * @returns Список либо `null`, если бэкенд не считал.
+   */
+  messengerSubscriptions: $PropertyType<UserDTO, "messengerSubscriptions">;
+
+  /**
+   * Пора предлагать продление занятий с репетитором.
+   * @returns `true`, если пора.
+   */
+  needToPromoteRenewalWithCoach: $PropertyType<
+    UserDTO,
+    "needToPromoteRenewalWithCoach"
+  >;
+
+  /**
+   * Показывать баннер курсов следующего учебного года.
+   * @returns `true`, если показывать.
+   */
+  nextYearCoursesBannerAvailable: $PropertyType<
+    UserDTO,
+    "nextYearCoursesBannerAvailable"
+  >;
+
+  /**
+   * Пароль задан — вход не только через код или соцсеть.
+   * @returns `true`, `false` либо `null`, если бэкенд не считал.
+   */
+  passwordSet: $PropertyType<UserDTO, "passwordSet">;
+
+  /**
+   * Реферальный код для программы «приведи друга».
+   * @returns Строка либо `null`, если код не выдан.
+   */
+  referralCode: $PropertyType<UserDTO, "referralCode">;
+
+  /**
+   * Доступен онбординг целевых действий.
+   * @returns `true`, если доступен.
+   */
+  targetActionsOnboardingAvailable: $PropertyType<
+    UserDTO,
+    "targetActionsOnboardingAvailable"
+  >;
+
   /**
    * Идёт ли сейчас окно пролонгации договора домашней школы.
    *
    * Границы включаются: последний день окна ещё считается пролонгацией. Не заданная граница
    * означает, что окна нет вовсе, а не что оно бесконечно.
+   * @returns `true`, если сегодня внутри окна включительно
    */
   isProlongationBetweenDates(): boolean;
+
+  /**
+   * Гость — сущность с умолчаниями всех полей и признаком `isDefaultUser()`.
+   * @returns Новая сущность на каждый вызов: умолчания общие на процесс, копия своя.
+   */
   static createDefault(): User;
 
   /**
    * Форма посетителя по умолчанию ДАННЫМИ — гость со всеми полями: тому, кто отдаёт `UserDTO`
    * наружу (хост — приложениям), нужна полная форма, а не сущность с методами. Своя копия на
    * вызов: умолчания общие на процесс, и правка чужой копии их не тронет.
+   * @returns Новая копия умолчаний на каждый вызов
    */
   static defaultDto(): UserDTO;
+
+  /**
+   * Сущность из профиля бэкенда (`UserDTO` в camelCase): строковые поля чистятся от null-байтов
+   * и пробелов по краям, остальное берётся как есть.
+   * @param input - Профиль в форме `UserDTO`
+   * @returns Сущность над копией профиля: исходный объект не трогается
+   */
   static fromApi(input: mixed): User;
+
+  /**
+   * Сущность собрана из умолчаний (`createDefault`), а не из профиля бэкенда.
+   * @returns `true` у гостя по умолчанию
+   */
   isDefaultUser(): boolean;
+
+  /**
+   * Посетитель вошёл — у него есть идентификатор на бэкенде.
+   * @returns `true`, если `id` задан и положителен
+   */
   isLoggedIn(): boolean;
 
   /**
-   * Возвращает тектовое представление роли / класса пользователя
-   * @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;
 }