@foxford/sdk 8.0.1 → 8.1.0

package/entities.js

@@ -46,18 +46,34 @@ var DEFAULT_USER = {
     room: null,
     street: null
   },
+  admissionFinishesOn: null,
+  algoritmika: false,
   avatarUrl: "",
   bonus: {
     giftAmount: 0,
     realMoneyAmount: 0
   },
   bonusAmount: 0,
+  bonusesPageVisited: false,
+  canChangeSchoolInfo: false,
   cartItemsCount: 0,
   cartTemplateId: null,
   createdAt: null,
+  currentInterest: {
+    businessUnitAbbrs: [],
+    disciplineId: null,
+    gradeId: null,
+    levelId: null,
+    productFormat: null,
+    productId: null,
+    reason: null
+  },
   disciplineIds: [],
   email: "",
   emailConfirmed: false,
+  externshipDemoAccessActive: false,
+  externshipPaymentRequired: null,
+  externshipPromoHeaderOn: false,
   externshipUser: false,
   fakeEmail: false,
   fakeUser: false,
@@ -76,25 +92,37 @@ var DEFAULT_USER = {
   hasActivePurchases: false,
   hasAttemptsSolveExamRehearsals: false,
   hasBookmarks: false,
+  hasExamProgressAccess: false,
   hasExternshipAttestationAccess: false,
   hasPurchasedExternshipContracts: false,
+  hasYearlyRecapAccess: false,
   id: null,
   isAgent: false,
+  isAttestationSchoolManager: null,
   isCoach: false,
   isCustomer: null,
   isElementaryPupil: false,
   isExternshipCoach: false,
   isGraduated: false,
+  isMentor: false,
   isMiniGroupTeacher: false,
   isParent: false,
+  isXpStreakAvailable: false,
   lastName: "",
+  leaderboard: null,
+  leaderboardAccessState: "unavailable",
+  learningGoalsAccessState: "disabled",
   locale: null,
+  messengerSubscriptions: null,
   methodist: false,
   middleName: "",
+  needToPromoteRenewalWithCoach: false,
+  nextYearCoursesBannerAvailable: false,
   onboardingFinished: false,
   onboardingFinishedAt: null,
   parentPhone: null,
   parentPhoneConfirmed: false,
+  passwordSet: null,
   phone: null,
   phoneConfirmed: false,
   privacy: {
@@ -103,11 +131,13 @@ var DEFAULT_USER = {
   profileEnriched: false,
   purchaseAnyExternshipContracts: false,
   recapUuid: null,
+  referralCode: null,
   shortName: "",
   skype: null,
   socialNets: [],
   socializationProfile: null,
   tags: null,
+  targetActionsOnboardingAvailable: false,
   timezone: null,
   type: null,
   webSocketNotificationsJwt: null
@@ -119,8 +149,9 @@ var _User = class _User {
     this.props = props;
     this.isDefault = isDefault;
     /**
-     * Возвращает роль пользователя
-     * @returns {UserRole} роль как строка
+     * Роль словом — по флагам профиля, первый совпавший: репетитор, учитель, родитель.
+     *
+     * @returns «Репетитор», «Учитель», «Родитель», иначе роль ученика из `getPupilRole()`
      */
     this.getRole = () => {
       if (this.isCoach) return "\u0420\u0435\u043F\u0435\u0442\u0438\u0442\u043E\u0440";
@@ -136,206 +167,694 @@ var _User = class _User {
       }
     };
     /**
-     * Возвращает фамилию и инициалы юзера
-     * @param {User} user
-     * @return {string} 'Пупкин В.'
+     * Фамилия с инициалами имени и отчества — подпись в списках.
+     *
+     * @returns Строка вида «Пупкин В. И.»; без отчества — «Пупкин В.»
      */
     this.getInitials = () => {
       var _a, _b;
       return `${this.lastName}${this.firstName ? ` ${(_a = this.firstName[0]) == null ? void 0 : _a.toUpperCase()}.` : ""}${this.middleName !== "" && this.middleName !== null ? ` ${(_b = this.middleName[0]) == null ? void 0 : _b.toUpperCase()}.` : ""}`;
     };
   }
+  /**
+   * Идентификатор посетителя на бэкенде.
+   *
+   * @returns Число либо `null` у гостя.
+   */
   get id() {
     return this.props.id;
   }
+  /**
+   * Почта посетителя.
+   *
+   * @returns Строка; пустая, если почты нет.
+   */
   get email() {
     return this.props.email;
   }
+  /**
+   * Имя.
+   *
+   * @returns Строка; пустая, если не заполнено.
+   */
   get firstName() {
     return this.props.firstName;
   }
+  /**
+   * Отчество.
+   *
+   * @returns Строка; пустая, если не заполнено.
+   */
   get middleName() {
     return this.props.middleName;
   }
+  /**
+   * Фамилия.
+   *
+   * @returns Строка; пустая, если не заполнено.
+   */
   get lastName() {
     return this.props.lastName;
   }
+  /**
+   * Полное имя, каким его собрал бэкенд.
+   *
+   * @returns Строка; пустая у гостя.
+   */
   get fullName() {
     return this.props.fullName;
   }
+  /**
+   * Короткое имя для обращения в интерфейсе.
+   *
+   * @returns Строка; пустая у гостя.
+   */
   get shortName() {
     return this.props.shortName;
   }
+  /**
+   * Когда заведён профиль.
+   *
+   * @returns Дата ISO либо `null` у гостя.
+   */
   get createdAt() {
     return this.props.createdAt;
   }
+  /**
+   * Часовой пояс посетителя.
+   *
+   * @returns Имя пояса либо `null`, если не задан.
+   */
   get timezone() {
     return this.props.timezone;
   }
+  /**
+   * Локаль интерфейса.
+   *
+   * @returns Код локали либо `null`, если не задана.
+   */
   get locale() {
     return this.props.locale;
   }
+  /**
+   * Класс посетителя: id, порядковый номер, имя и транслит.
+   *
+   * @returns Объект класса; у гостя поля `null` и пустые строки.
+   */
   get grade() {
     return this.props.grade;
   }
+  /**
+   * Телефон посетителя.
+   *
+   * @returns Строка либо `null`, если не указан.
+   */
   get phone() {
     return this.props.phone;
   }
+  /**
+   * Адрес аватара.
+   *
+   * @returns Строка; пустая, если аватара нет.
+   */
   get avatarUrl() {
     return this.props.avatarUrl;
   }
+  /**
+   * Посетитель — родитель.
+   *
+   * @returns `true`, если роль родительская.
+   */
   get isParent() {
     return this.props.isParent;
   }
+  /**
+   * Посетитель — выпускник.
+   *
+   * @returns `true`, если школу закончил.
+   */
   get isGraduated() {
     return this.props.isGraduated;
   }
+  /**
+   * Класс подтверждён посетителем.
+   *
+   * @returns `true`, если класс проверен.
+   */
   get gradeChecked() {
     return this.props.gradeChecked;
   }
+  /**
+   * Тип учётной записи на бэкенде.
+   *
+   * @returns `pupil`, `agent` либо `null` у гостя.
+   */
   get type() {
     return this.props.type;
   }
+  /**
+   * Посетитель — репетитор.
+   *
+   * @returns `true`, если роль репетитора.
+   */
   get isCoach() {
     return this.props.isCoach;
   }
+  /**
+   * Ведёт мини-группы.
+   *
+   * @returns `true`, если ведёт.
+   */
   get isMiniGroupTeacher() {
     return this.props.isMiniGroupTeacher;
   }
+  /**
+   * Репетитор экстерната.
+   *
+   * @returns `true`, если ведёт экстернат.
+   */
   get isExternshipCoach() {
     return this.props.isExternshipCoach;
   }
+  /**
+   * Посетитель — учитель.
+   *
+   * @returns `true`, если роль учителя.
+   */
   get isAgent() {
     return this.props.isAgent;
   }
+  /**
+   * Посетитель — методист.
+   *
+   * @returns `true`, если методист.
+   */
   get methodist() {
     return this.props.methodist;
   }
+  /**
+   * Почтовый адрес: страна, регион, город, улица, дом.
+   *
+   * @returns Объект адреса либо `null`, если не заполнен.
+   */
   get address() {
     return this.props.address;
   }
+  /**
+   * Привязанные соцсети.
+   *
+   * @returns Список провайдеров с идентификаторами; пустой, если привязок нет.
+   */
   get socialNets() {
     return this.props.socialNets;
   }
+  /**
+   * Логин в Skype.
+   *
+   * @returns Строка либо `null`.
+   */
   get skype() {
     return this.props.skype;
   }
+  /**
+   * Настройки интерфейса: показанные подсказки и скрытые баннеры.
+   *
+   * @returns Объект флагов либо `undefined`, если бэкенд их не прислал.
+   */
   get settings() {
     return this.props.settings;
   }
+  /**
+   * Бонусный счёт: подарочные и реальные бонусы.
+   *
+   * @returns Объект с суммами.
+   */
   get bonus() {
     return this.props.bonus;
   }
+  /**
+   * Сумма бонусов на счёте.
+   *
+   * @returns Число.
+   */
   get bonusAmount() {
     return this.props.bonusAmount;
   }
+  /**
+   * Есть действующие покупки.
+   *
+   * @returns `true`, если есть.
+   */
   get hasActivePurchases() {
     return this.props.hasActivePurchases;
   }
+  /**
+   * Остались попытки пробных экзаменов.
+   *
+   * @returns `true`, если остались.
+   */
   get hasAttemptsSolveExamRehearsals() {
     return this.props.hasAttemptsSolveExamRehearsals;
   }
+  /**
+   * Есть закладки.
+   *
+   * @returns `true`, если есть.
+   */
   get hasBookmarks() {
     return this.props.hasBookmarks;
   }
+  /**
+   * Метки посетителя на бэкенде.
+   *
+   * @returns Список строк либо `null`.
+   */
   get tags() {
     return this.props.tags;
   }
+  /**
+   * Шаблон корзины.
+   *
+   * @returns Число либо `null`.
+   */
   get cartTemplateId() {
     return this.props.cartTemplateId;
   }
+  /**
+   * Сколько позиций в корзине.
+   *
+   * @returns Число.
+   */
   get cartItemsCount() {
     return this.props.cartItemsCount;
   }
+  /**
+   * Онбординг пройден.
+   *
+   * @returns `true`, если пройден.
+   */
   get onboardingFinished() {
     return this.props.onboardingFinished;
   }
+  /**
+   * Когда пройден онбординг.
+   *
+   * @returns Дата ISO либо `null`, пока не пройден.
+   */
   get onboardingFinishedAt() {
     return this.props.onboardingFinishedAt;
   }
+  /**
+   * Почта подтверждена.
+   *
+   * @returns `true`, если подтверждена.
+   */
   get emailConfirmed() {
     return this.props.emailConfirmed;
   }
+  /**
+   * Телефон подтверждён.
+   *
+   * @returns `true`, если подтверждён.
+   */
   get phoneConfirmed() {
     return this.props.phoneConfirmed;
   }
+  /**
+   * Почта выдумана бэкендом при регистрации без почты.
+   *
+   * @returns `true`, если почта ненастоящая.
+   */
   get fakeEmail() {
     return this.props.fakeEmail;
   }
+  /**
+   * Посетитель заведён бэкендом без его участия (например, по заявке).
+   *
+   * @returns `true`, если учётная запись ненастоящая.
+   */
   get fakeUser() {
     return this.props.fakeUser;
   }
+  /**
+   * Профиль дополнен данными после регистрации.
+   *
+   * @returns `true`, если дополнен.
+   */
   get profileEnriched() {
     return this.props.profileEnriched;
   }
+  /**
+   * Идентификатор итогов года.
+   *
+   * @returns Строка либо `null`, если итогов нет.
+   */
   get recapUuid() {
     return this.props.recapUuid;
   }
+  /**
+   * Дисциплины, которые изучает посетитель.
+   *
+   * @returns Список id; пустой, если не выбраны.
+   */
   get disciplineIds() {
     return this.props.disciplineIds;
   }
+  /**
+   * Настройки приватности.
+   *
+   * @returns Объект с флагом публичного профиля.
+   */
   get privacy() {
     return this.props.privacy;
   }
+  /**
+   * Телефон родителя.
+   *
+   * @returns Строка либо `null`.
+   */
   get parentPhone() {
     return this.props.parentPhone;
   }
+  /**
+   * Телефон родителя подтверждён.
+   *
+   * @returns `true`, если подтверждён.
+   */
   get parentPhoneConfirmed() {
     return this.props.parentPhoneConfirmed;
   }
+  /**
+   * Посетитель что-то покупал.
+   *
+   * @returns `true`, `false` либо `null`, если бэкенд не считал.
+   */
   get isCustomer() {
     return this.props.isCustomer;
   }
+  /**
+   * Доступны многодневные серии занятий.
+   *
+   * @returns `true`, если доступны.
+   */
   get hasAccessToMultiDaysStreaks() {
     return this.props.hasAccessToMultiDaysStreaks;
   }
+  /**
+   * Ученик начальной школы.
+   *
+   * @returns `true`, если начальная школа.
+   */
   get isElementaryPupil() {
     return this.props.isElementaryPupil;
   }
+  /**
+   * Токен для канала уведомлений по WebSocket.
+   *
+   * @returns Строка либо `null`, если канала нет.
+   */
   get webSocketNotificationsJwt() {
     return this.props.webSocketNotificationsJwt;
   }
+  /**
+   * Доступны аттестационные листы.
+   *
+   * @returns `true`, если доступны.
+   */
   get hasAccessToAttestationSheets() {
     return this.props.hasAccessToAttestationSheets;
   }
+  /**
+   * Посетитель учится в экстернате.
+   *
+   * @returns `true`, если экстернат.
+   */
   get externshipUser() {
     return this.props.externshipUser;
   }
+  /**
+   * Есть оплаченные договоры экстерната.
+   *
+   * @returns `true`, если есть.
+   */
   get hasPurchasedExternshipContracts() {
     return this.props.hasPurchasedExternshipContracts;
   }
+  /**
+   * Доступна аттестация экстерната.
+   *
+   * @returns `true`, если доступна.
+   */
   get hasExternshipAttestationAccess() {
     return this.props.hasExternshipAttestationAccess;
   }
+  /**
+   * Профиль в разделе социализации.
+   *
+   * @returns Объект с id и состоянием либо `null`, если профиля нет.
+   */
   get socializationProfile() {
     return this.props.socializationProfile;
   }
+  /**
+   * Когда заканчивается бесплатный доступ.
+   *
+   * @returns Дата ISO либо `null`, если доступа нет.
+   */
   get freeAccessFinishesAt() {
     return this.props.freeAccessFinishesAt;
   }
+  /**
+   * В комнате начальной школы есть непросмотренные новинки.
+   *
+   * @returns `true`, если есть; `undefined`, если бэкенд не прислал.
+   */
   get hasUnseenRoomFeatures() {
     return this.props.hasUnseenRoomFeatures;
   }
+  /**
+   * Покупал договоры экстерната.
+   *
+   * @returns `true`, если покупал.
+   */
   get purchaseAnyExternshipContracts() {
     return this.props.purchaseAnyExternshipContracts;
   }
+  /**
+   * Связан с экстернатом: ученик, родитель либо репетитор.
+   *
+   * @returns `true`, если связан; `undefined`, если бэкенд не прислал.
+   */
   get hasExternshipRelation() {
     return this.props.hasExternshipRelation;
   }
+  /**
+   * Есть действующий договор экстерната.
+   *
+   * @returns `true`, если есть; `undefined`, если бэкенд не прислал.
+   */
   get hasExternshipActiveContract() {
     return this.props.hasExternshipActiveContract;
   }
+  /**
+   * Можно продлить договор домашней школы.
+   *
+   * @returns `true`, если можно; `undefined`, если бэкенд не прислал.
+   */
   get canProlongateContract() {
     return this.props.canProlongateContract;
   }
+  /**
+   * Окно пролонгации договора: даты, скидка, заголовок следующего года.
+   *
+   * @returns Объект окна, `null` либо `undefined`, если окна нет.
+   */
   get prolongation() {
     return this.props.prolongation;
   }
+  /**
+   * Текущий интерес посетителя: класс, дисциплина, уровень, формат и причина. Та же форма, что у `GET /api/user/user_interest`, но из профиля, без похода.
+   *
+   * @returns Объект интереса либо `null`, если бэкенд не считал.
+   */
+  get currentInterest() {
+    return this.props.currentInterest;
+  }
+  /**
+   * До какой даты открыт приём в домашнюю школу.
+   *
+   * @returns Дата либо `null`, если приём не идёт.
+   */
+  get admissionFinishesOn() {
+    return this.props.admissionFinishesOn;
+  }
+  /**
+   * Посетитель пришёл из Алгоритмики — партнёрский вход с другой площадки.
+   *
+   * @returns `true`, если из Алгоритмики.
+   */
+  get algoritmika() {
+    return this.props.algoritmika;
+  }
+  /**
+   * Страница бонусов уже открывалась — подсказки на ней больше не показываются.
+   *
+   * @returns `true`, если открывалась.
+   */
+  get bonusesPageVisited() {
+    return this.props.bonusesPageVisited;
+  }
+  /**
+   * Посетителю разрешено менять школу и класс в профиле.
+   *
+   * @returns `true`, если разрешено.
+   */
+  get canChangeSchoolInfo() {
+    return this.props.canChangeSchoolInfo;
+  }
+  /**
+   * Идёт демо-доступ к экстернату.
+   *
+   * @returns `true`, пока демо активно.
+   */
+  get externshipDemoAccessActive() {
+    return this.props.externshipDemoAccessActive;
+  }
+  /**
+   * Экстернат ждёт оплаты: когда закроется доступ и по какому договору.
+   *
+   * @returns Объект с датой и id договора либо `null`, если долга нет.
+   */
+  get externshipPaymentRequired() {
+    return this.props.externshipPaymentRequired;
+  }
+  /**
+   * Показывать промо-шапку экстерната.
+   *
+   * @returns `true`, если показывать.
+   */
+  get externshipPromoHeaderOn() {
+    return this.props.externshipPromoHeaderOn;
+  }
+  /**
+   * Доступен раздел прогресса подготовки к экзаменам.
+   *
+   * @returns `true`, если доступен.
+   */
+  get hasExamProgressAccess() {
+    return this.props.hasExamProgressAccess;
+  }
+  /**
+   * Доступны итоги года; их адрес — `recapUuid`.
+   *
+   * @returns `true`, если доступны.
+   */
+  get hasYearlyRecapAccess() {
+    return this.props.hasYearlyRecapAccess;
+  }
+  /**
+   * Управляет аттестационной школой.
+   *
+   * @returns `true`, `false` либо `null`, если бэкенд не считал.
+   */
+  get isAttestationSchoolManager() {
+    return this.props.isAttestationSchoolManager;
+  }
+  /**
+   * Посетитель — наставник.
+   *
+   * @returns `true`, если наставник.
+   */
+  get isMentor() {
+    return this.props.isMentor;
+  }
+  /**
+   * Доступна серия ежедневных занятий с опытом (XP-стрик).
+   *
+   * @returns `true`, если доступна.
+   */
+  get isXpStreakAvailable() {
+    return this.props.isXpStreakAvailable;
+  }
+  /**
+   * Таблица лидеров: доступна ли посетителю и готов ли он к ней (выбор курса).
+   *
+   * @returns Объект состояний либо `null`, если посетитель вне программы.
+   */
+  get leaderboard() {
+    return this.props.leaderboard;
+  }
+  /**
+   * Состояние доступа к таблице лидеров.
+   *
+   * @returns `unavailable`, `available`, `vacation` либо `disabled`.
+   */
+  get leaderboardAccessState() {
+    return this.props.leaderboardAccessState;
+  }
+  /**
+   * Как устроены учебные цели у посетителя.
+   *
+   * @returns `enabled`, `disabled`, `optional` либо `required`.
+   */
+  get learningGoalsAccessState() {
+    return this.props.learningGoalsAccessState;
+  }
+  /**
+   * Мессенджеры, на которые посетитель подписан на уведомления.
+   *
+   * @returns Список либо `null`, если бэкенд не считал.
+   */
+  get messengerSubscriptions() {
+    return this.props.messengerSubscriptions;
+  }
+  /**
+   * Пора предлагать продление занятий с репетитором.
+   *
+   * @returns `true`, если пора.
+   */
+  get needToPromoteRenewalWithCoach() {
+    return this.props.needToPromoteRenewalWithCoach;
+  }
+  /**
+   * Показывать баннер курсов следующего учебного года.
+   *
+   * @returns `true`, если показывать.
+   */
+  get nextYearCoursesBannerAvailable() {
+    return this.props.nextYearCoursesBannerAvailable;
+  }
+  /**
+   * Пароль задан — вход не только через код или соцсеть.
+   *
+   * @returns `true`, `false` либо `null`, если бэкенд не считал.
+   */
+  get passwordSet() {
+    return this.props.passwordSet;
+  }
+  /**
+   * Реферальный код для программы «приведи друга».
+   *
+   * @returns Строка либо `null`, если код не выдан.
+   */
+  get referralCode() {
+    return this.props.referralCode;
+  }
+  /**
+   * Доступен онбординг целевых действий.
+   *
+   * @returns `true`, если доступен.
+   */
+  get targetActionsOnboardingAvailable() {
+    return this.props.targetActionsOnboardingAvailable;
+  }
   /**
    * Идёт ли сейчас окно пролонгации договора домашней школы.
    *
    * Границы включаются: последний день окна ещё считается пролонгацией. Не заданная граница
    * означает, что окна нет вовсе, а не что оно бесконечно.
+   *
+   * @returns `true`, если сегодня внутри окна включительно
    */
   isProlongationBetweenDates() {
     var _a;
@@ -381,6 +900,11 @@ var _User = class _User {
     });
     return clonedObj;
   }
+  /**
+   * Гость — сущность с умолчаниями всех полей и признаком `isDefaultUser()`.
+   *
+   * @returns Новая сущность на каждый вызов: умолчания общие на процесс, копия своя.
+   */
   static createDefault() {
     return new _User(this.deepClone(DEFAULT_USER), true);
   }
@@ -388,6 +912,8 @@ var _User = class _User {
    * Форма посетителя по умолчанию ДАННЫМИ — гость со всеми полями: тому, кто отдаёт `UserDTO`
    * наружу (хост — приложениям), нужна полная форма, а не сущность с методами. Своя копия на
    * вызов: умолчания общие на процесс, и правка чужой копии их не тронет.
+   *
+   * @returns Новая копия умолчаний на каждый вызов
    */
   static defaultDto() {
     return this.deepClone(DEFAULT_USER);
@@ -405,6 +931,13 @@ var _User = class _User {
     }
     return str.replace(/\x00/g, "").trim();
   }
+  /**
+   * Сущность из профиля бэкенда (`UserDTO` в camelCase): строковые поля чистятся от null-байтов
+   * и пробелов по краям, остальное берётся как есть.
+   *
+   * @param input - Профиль в форме `UserDTO`
+   * @returns Сущность над копией профиля: исходный объект не трогается
+   */
   static fromApi(input) {
     const sanitizedData = this.sanitizeUserData(this.deepClone(input));
     return new _User(sanitizedData);
@@ -425,16 +958,26 @@ var _User = class _User {
       shortName: this.sanitizeString(data.shortName)
     });
   }
+  /**
+   * Сущность собрана из умолчаний (`createDefault`), а не из профиля бэкенда.
+   *
+   * @returns `true` у гостя по умолчанию
+   */
   isDefaultUser() {
     return this.isDefault;
   }
+  /**
+   * Посетитель вошёл — у него есть идентификатор на бэкенде.
+   *
+   * @returns `true`, если `id` задан и положителен
+   */
   isLoggedIn() {
     return this.id && this.id > 0 ? true : false;
   }
   /**
-   * Возвращает тектовое представление роли / класса пользователя
+   * Роль либо класс словом — для подписи в интерфейсе.
    *
-   * @returns {UserRole}
+   * @returns «Дошкольник» для нулевого класса, «Выпускник» без класса, иначе класс («5 класс»)
    */
   getPupilRole() {
     if (this.grade.index === 0) {
@@ -443,12 +986,19 @@ var _User = class _User {
     if (this.grade.index == null) return "\u0412\u044B\u043F\u0443\u0441\u043A\u043D\u0438\u043A";
     return _User.getGradeString(this.grade.index);
   }
+  /**
+   * Профиль строкой JSON — для печати в документ и передачи по сети.
+   *
+   * @returns JSON полей сущности
+   */
   toJson() {
     return JSON.stringify(this.props);
   }
   /**
    * Посетитель данными — то, что едет по сети и в состояние: сущность с методами не
    * сериализуется. Своя копия на вызов: сущность неизменяема, и правка копии её не тронет.
+   *
+   * @returns Копия полей сущности данными
    */
   toDto() {
     return _User.deepClone(this.props);