zdu-student-api 1.1.5 → 1.1.7

package/dist/cabinetStudent/types.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Анкетні дані студента
+ * @category CabinetStudent
+ * @remarks
+ * **Статус запиту:**
+ * - `ok` — Успіх отримання даних (true/false)
+ *
+ * **ПІБ студента:**
+ * - `fullName` — Повне ім'я студента (Прізвище Ім'я По батькові)
+ * - `lastName` — Прізвище
+ * - `firstName` — Ім'я
+ * - `middleName` — По батькові
+ *
+ * **Загальні дані:**
+ * - `birthDate` — Дата народження (формат: DD.MM.YYYY)
+ * - `gender` — Стать (Чол/Жін)
+ * - `previousFullName` — Попереднє ПІБ студента (якщо змінювалось)
+ * - `country` — Країна, з якої навчається студент
+ * - `lastNameEng` — Прізвище англійською
+ * - `firstNameEng` — Ім'я англійською
+ * - `middleNameEng` — По батькові англійською (зазвичай немає)
+ *
+ * **Контактні дані:**
+ * - `email` — Електронна пошта студента
+ * - `phones` — Масив телефонних номерів студента
+ *
+ * **Дані про навчання:**
+ * - `faculty` — Факультет
+ * - `specialty` — Спеціальність (назва освітньої програми)
+ * - `degree` — Ступінь / Освітньо-професійний ступінь (бакалавр, магістр тощо)
+ * - `group` — Академічна група
+ * - `studyForm` — Форма навчання (Денна, Заочна, Вечірня)
+ * - `paymentForm` — Форма оплати навчання (Держ.замовлення, Контракт)
+ * - `enrollmentOrder` — Номер наказу на зарахування
+ * - `enrollmentDate` — Дата наказу на зарахування (формат: DD.MM.YYYY)
+ * - `studyDuration` — Термін навчання (наприклад: "4 роки")
+ * - `graduationDate` — Дата закінчення навчання (формат: DD.MM.YYYY)
+ */
+export interface DataStudent {
+    ok: boolean;
+    fullName?: string;
+    lastName?: string;
+    firstName?: string;
+    middleName?: string;
+    birthDate?: string;
+    gender?: string;
+    previousFullName?: string;
+    country?: string;
+    lastNameEng?: string;
+    firstNameEng?: string;
+    middleNameEng?: string;
+    email?: string;
+    phones?: string[];
+    faculty?: string;
+    specialty?: string;
+    degree?: string;
+    group?: string;
+    studyForm?: string;
+    paymentForm?: string;
+    enrollmentOrder?: string;
+    enrollmentDate?: string;
+    studyDuration?: string;
+    graduationDate?: string;
+}
+/**
+ * name та prId дисципліни
+ * @category CabinetStudent
+ * @remarks
+ * - `name` — Повна назва дисципліни
+ * - `prId` — Айді дисципліни
+ */
+export interface Discipline {
+    name: string;
+    prId: string;
+}
+/**
+ * name та prId дисципліни
+ * @category CabinetStudent
+ * @remarks
+ * - `ok` — Успіх отримання токену
+ * - `disciplines` — Масив дисциплін {@link Discipline}
+ */
+export interface Disciplines {
+    ok: boolean;
+    disciplines: Discipline[];
+}
+/**
+ * Опис заняття у кабінеті студента
+ * @category CabinetStudent
+ * @remarks
+ * - `teacher` — Прізвище та ініціали викладача
+ * - `date` — Дата заняття у форматі "dd.mm.yyyy"
+ * - `type` — Тип заняття: "Лек", "ПрСем", "Лаб", "МК", "Екз"
+ * - `time` — Час заняття у форматі "HH:MM-HH:MM"
+ * - `index` — Значення атрибута `data-ind`, унікальний ідентифікатор
+ */
+export interface ScheduleItem {
+    teacher: string;
+    date: string;
+    type: string;
+    time: string;
+    index: string;
+}
+/**
+ * Список оцінок студента.
+ * @category CabinetStudent
+ * @remarks
+ * - `id` — Унікальний ідентифікатор студента
+ * - `scores` — Оцінки по днях, масив масивів рядків (перший елемент - основна оцінка, другий елемент - оцінка перездачі)
+ * - `absences` — Кількість пропусків
+ * - `uabsences` — Кількість невиправлених пропусків
+ * - `finalScore` — Фінальна оцінка
+ */
+export interface StudentScores {
+    id: string;
+    scores: string[][];
+    absences: number;
+    uabsences: number;
+    finalScore: string;
+}
+/**
+ * Об'єкт оцінок з предмету.
+ * @category CabinetStudent
+ * @remarks
+ * - `ok` — Успіх отримання токену
+ * - `prId` — Айді дисципліни
+ * - `studentId` — Унікальний айді студента для предметів
+ * - `scheduleItem` — Опис заняття у кабінеті студента {@link ScheduleItem}
+ * - `studentScores` — Список оцінок студента {@link StudentScores}
+ */
+export interface Scores {
+    ok: boolean;
+    prId: string;
+    studentId: string;
+    scheduleItem: ScheduleItem[];
+    studentScores: StudentScores[];
+}

package/dist/cabinetStudent/types.js

@@ -0,0 +1 @@
+export {};

package/dist/cabinetTeacher/academicGroups.d.ts

@@ -0,0 +1,10 @@
+import { AcademicGroups } from './types.js';
+/**
+ * Отримати всі академічні групи
+ * @category CabinetTeacher
+ * @param sesId - ID сесії користувача
+ * @param sessGUID - GUID сесії з cookie
+ * @throws {Error} Якщо виникають проблеми з запитом або дані некоректні.
+ * @returns Об'єкт академічних груп {@link AcademicGroups}
+ */
+export declare function getAcademicGroups(sesId: string, sessGUID: string): Promise<AcademicGroups>;

package/dist/cabinetTeacher/academicGroups.js

@@ -0,0 +1,36 @@
+import fetch from 'cross-fetch';
+import iconv from 'iconv-lite';
+import { generateCookieString, isLoginPage } from '../cabinet/session.js';
+import { parseGroupsPage } from '../cabinet/parsers.js';
+/**
+ * Отримати всі академічні групи
+ * @category CabinetTeacher
+ * @param sesId - ID сесії користувача
+ * @param sessGUID - GUID сесії з cookie
+ * @throws {Error} Якщо виникають проблеми з запитом або дані некоректні.
+ * @returns Об'єкт академічних груп {@link AcademicGroups}
+ */
+export async function getAcademicGroups(sesId, sessGUID) {
+    try {
+        let result = { ok: false, groups: [] };
+        const cookieString = generateCookieString(sessGUID);
+        const response1 = await fetch(`https://dekanat.zu.edu.ua/cgi-bin/kaf.cgi?half=0&sesID=${sesId}&n=2&action=groups`, { headers: { Cookie: cookieString } });
+        const buffer1 = await response1.arrayBuffer();
+        const html1 = iconv.decode(Buffer.from(buffer1), 'windows-1251');
+        if (isLoginPage(html1))
+            return result;
+        result.groups = parseGroupsPage(html1, 1);
+        const response2 = await fetch(`https://dekanat.zu.edu.ua/cgi-bin/kaf.cgi?half=1&sesID=${sesId}&n=2&action=groups`, { headers: { Cookie: cookieString } });
+        const buffer2 = await response2.arrayBuffer();
+        const html2 = iconv.decode(Buffer.from(buffer2), 'windows-1251');
+        if (isLoginPage(html2))
+            return result;
+        result.groups = [...result.groups, ...parseGroupsPage(html2, 2)];
+        result.ok = true;
+        return result;
+    }
+    catch (e) {
+        console.error('Error in getAcademicGroups:', e);
+        throw e;
+    }
+}

package/dist/cabinetTeacher/cabinetTeacher.d.ts

@@ -0,0 +1,71 @@
+import { DataTeacher, AcademicGroups, AcademicGroup } from './types.js';
+/**
+ * Клас кабінету викладача
+ * @category CabinetTeacher
+ */
+export declare class CabinetTeacher {
+    /**
+     * Логін користувача
+     */
+    login: string;
+    /**
+     * Пароль від кабінету викладача
+     */
+    password: string;
+    /**
+     * ID сесії викладача
+     */
+    sesID?: string;
+    /**
+     * GUID сесії з cookie
+     */
+    sessGUID?: string;
+    /**
+     * Семестр для пошуку оцінок (0 - перший, 1 - другий)
+     */
+    semester: 1 | 2;
+    /**
+     * Данні викладача {@link DataTeacher}
+     */
+    data?: DataTeacher;
+    /**
+     * Список академічних груп {@link AcademicGroup}
+     */
+    academicGroups: AcademicGroup[];
+    /**
+     * Конструктор
+     * @param login - Логін користувача
+     * @param password - Пароль
+     */
+    constructor(login: string, password: string);
+    /**
+     * Авторизація
+     */
+    auth(login?: string, password?: string): Promise<boolean>;
+    /**
+     * Базове значення семестру
+     */
+    private setSemester;
+    /**
+     * Отримання всіх данних
+     */
+    loadData(): Promise<boolean>;
+    /**
+     * Відновлення сесії
+     */
+    setSession(sesID: string, sessGUID: string): Promise<boolean>;
+    /**
+     * Перевірка валідності сесії
+     */
+    isValidSession(): Promise<boolean>;
+    /**
+     * Отримати всі академічні групи
+     * @returns Об'єкт академічних груп {@link AcademicGroups}
+     */
+    getAcademicGroups(): Promise<AcademicGroups>;
+    /**
+     * Отримати анкетні данні викладача
+     * @returns Об'єкт {@link Data}
+     */
+    getData(): Promise<DataTeacher>;
+}

package/dist/cabinetTeacher/cabinetTeacher.js

@@ -0,0 +1,132 @@
+import { getSesId } from '../cabinet/session.js';
+import { isValidSession } from '../cabinet/session.js';
+import { getAcademicGroups } from './academicGroups.js';
+import { getDataTeacher } from '../cabinet/data.js';
+import { getSemester } from '../cabinet/utils.js';
+/**
+ * Клас кабінету викладача
+ * @category CabinetTeacher
+ */
+export class CabinetTeacher {
+    /**
+     * Логін користувача
+     */
+    login;
+    /**
+     * Пароль від кабінету викладача
+     */
+    password;
+    /**
+     * ID сесії викладача
+     */
+    sesID;
+    /**
+     * GUID сесії з cookie
+     */
+    sessGUID;
+    /**
+     * Семестр для пошуку оцінок (0 - перший, 1 - другий)
+     */
+    semester = 1;
+    /**
+     * Данні викладача {@link DataTeacher}
+     */
+    data;
+    /**
+     * Список академічних груп {@link AcademicGroup}
+     */
+    academicGroups = [];
+    /**
+     * Конструктор
+     * @param login - Логін користувача
+     * @param password - Пароль
+     */
+    constructor(login, password) {
+        this.login = login;
+        this.password = password;
+    }
+    /**
+     * Авторизація
+     */
+    async auth(login, password) {
+        const accountData = await getSesId(login ?? this.login, password ?? this.password, 'teacher');
+        this.setSemester();
+        if (accountData.ok) {
+            this.sesID = accountData.sesID;
+            this.sessGUID = accountData.sessGUID;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Базове значення семестру
+     */
+    setSemester() {
+        this.semester = getSemester();
+    }
+    /**
+     * Отримання всіх данних
+     */
+    async loadData() {
+        const one = (await this.getAcademicGroups()).ok;
+        const two = (await this.getData()).ok;
+        return one && two;
+    }
+    /**
+     * Відновлення сесії
+     */
+    async setSession(sesID, sessGUID) {
+        this.setSemester();
+        const ses = await isValidSession(sesID, sessGUID, 'teacher');
+        if (ses) {
+            this.sesID = sesID;
+            this.sessGUID = sessGUID;
+        }
+        return ses;
+    }
+    /**
+     * Перевірка валідності сесії
+     */
+    async isValidSession() {
+        if (!this.sesID || !this.sessGUID)
+            return false;
+        return await isValidSession(this.sesID, this.sessGUID, 'teacher');
+    }
+    /**
+     * Отримати всі академічні групи
+     * @returns Об'єкт академічних груп {@link AcademicGroups}
+     */
+    async getAcademicGroups() {
+        if (!this.sesID || !this.sessGUID)
+            return { ok: false, groups: [] };
+        try {
+            const academicGroupsData = await getAcademicGroups(this.sesID, this.sessGUID);
+            if (academicGroupsData.ok) {
+                this.academicGroups = academicGroupsData.groups;
+            }
+            return academicGroupsData;
+        }
+        catch {
+            return { ok: false, groups: [] };
+        }
+    }
+    /**
+     * Отримати анкетні данні викладача
+     * @returns Об'єкт {@link Data}
+     */
+    async getData() {
+        if (!this.sesID || !this.sessGUID)
+            return { ok: false };
+        try {
+            const data = await getDataTeacher(this.sesID, this.sessGUID);
+            if (data.ok) {
+                this.data = data;
+            }
+            return data;
+        }
+        catch (err) {
+            console.log(err);
+            return { ok: false };
+        }
+    }
+}

package/dist/cabinetTeacher/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './academicGroups.js';
+export * from './cabinetTeacher.js';

package/dist/cabinetTeacher/index.js

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './academicGroups.js';
+export * from './cabinetTeacher.js';

package/dist/cabinetTeacher/types.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Дані викладача з головної сторінки кабінету
+ * @category CabinetTeacher
+ * @remarks
+ * **Статус запиту:**
+ * - `ok` — Успіх отримання даних (true/false)
+ *
+ * **ПІБ викладача:**
+ * - `fullName` — Повне ім'я викладача (Прізвище Ім'я По батькові)
+ * - `lastName` — Прізвище
+ * - `firstName` — Ім'я
+ * - `middleName` — По батькові
+ *
+ * **Інформація про роботу:**
+ * - `department` — Назва кафедри
+ * - `partTimeHours` — Кількість годин за сумісництвом (число без "год.")
+ * - `workDurationMonths` — Тривалість роботи в навчальному році (місяців)
+ * - `totalPositionHours` — Загальна кількість годин за ставками (число без "год.")
+ * - `workloadByStaff` — Розподілене навантаження за штатом (число без "год.")
+ * - `totalWorkload` — Загальне розподілене навантаження (число без "год.")
+ */
+export interface DataTeacher {
+    ok: boolean;
+    fullName?: string;
+    lastName?: string;
+    firstName?: string;
+    middleName?: string;
+    department?: string;
+    partTimeHours?: number;
+    workDurationMonths?: number;
+    totalPositionHours?: number;
+    workloadByStaff?: number;
+    totalWorkload?: number;
+}
+/**
+ * Інформація про академічну групу
+ * @category CabinetTeacher
+ * @remarks
+ * - `name` — Назва групи (наприклад: "23Мд-СОфіз")
+ * - `semester` — Семестр: "1" (перше), "2" (друге)
+ * - `encodedName` — URL-encoded назва групи для запитів
+ * - `course` — Номер курсу (1-4)
+ * - `specialty` — Повна назва спеціальності з кодом
+ * - `faculty` — Назва факультету
+ * - `teacherId` — ID викладача з параметра teacher в URL
+ * - `journalUrl` — Відносний URL для переходу до журналу групи
+ */
+export interface AcademicGroup {
+    name: string;
+    semester: number;
+    encodedName: string;
+    course: number;
+    specialty: string;
+    faculty: string;
+    teacherId: string;
+    journalUrl: string;
+}
+/**
+ * Список академічних груп викладача
+ * @category CabinetTeacher
+ * @remarks
+ * - `ok` — Успіх отримання даних (true/false)
+ * - `groups` — Масив груп {@link Group}
+ */
+export interface AcademicGroups {
+    ok: boolean;
+    groups: AcademicGroup[];
+}

package/dist/cabinetTeacher/types.js

@@ -0,0 +1 @@
+export {};

package/dist/constants.d.ts

@@ -1,58 +1,58 @@
 import { Faculty } from './types.js';
 /**
-* Список факультетів університету.
-* @category Schedule
-*
-* @remarks
-* - `none`: { id: 0, name: 'Оберіть факультет' }
-* - `physicsMath`: { id: 1001, name: 'Фізико-математичний факультет' }
-* - `philologyJournalism`: { id: 1002, name: 'Навчально-науковий інститут філології та журналістики' }
-* - `historyLawPublic`: { id: 1003, name: 'Факультет історії, права та публічного управління' }
-* - `foreignPhilology`: { id: 1004, name: 'Навчально-науковий інститут іноземної філології' }
-* - `natural`: { id: 1005, name: 'Природничий факультет' }
-* - `pedagogy`: { id: 1006, name: 'Навчально-науковий інститут педагогіки' }
-* - `socialPsychology`: { id: 1007, name: 'Соціально-психологічний факультет' }
-* - `physicalEducation`: { id: 1008, name: 'Факультет фізичного виховання і спорту' }
-* - `preUniversityCenter`: { id: 1009, name: 'Центр доуніверситетської освіти та освіти дорослих' }
-* - `partTime`: { id: 1010, name: 'Заочна форма навчання' }
-* - `postgraduate`: { id: 1011, name: 'Відділ аспірантури та докторантури' }
-* - `scientificLyceum`: { id: 1012, name: 'Науковий ліцей' }
-*/
+ * Список факультетів університету.
+ * @category Schedule
+ *
+ * @remarks
+ * - `none`: { id: 0, name: 'Оберіть факультет' }
+ * - `physicsMath`: { id: 1001, name: 'Фізико-математичний факультет' }
+ * - `philologyJournalism`: { id: 1002, name: 'Навчально-науковий інститут філології та журналістики' }
+ * - `historyLawPublic`: { id: 1003, name: 'Факультет історії, права та публічного управління' }
+ * - `foreignPhilology`: { id: 1004, name: 'Навчально-науковий інститут іноземної філології' }
+ * - `natural`: { id: 1005, name: 'Природничий факультет' }
+ * - `pedagogy`: { id: 1006, name: 'Навчально-науковий інститут педагогіки' }
+ * - `socialPsychology`: { id: 1007, name: 'Соціально-психологічний факультет' }
+ * - `physicalEducation`: { id: 1008, name: 'Факультет фізичного виховання і спорту' }
+ * - `preUniversityCenter`: { id: 1009, name: 'Центр доуніверситетської освіти та освіти дорослих' }
+ * - `partTime`: { id: 1010, name: 'Заочна форма навчання' }
+ * - `postgraduate`: { id: 1011, name: 'Відділ аспірантури та докторантури' }
+ * - `scientificLyceum`: { id: 1012, name: 'Науковий ліцей' }
+ */
 export declare const faculties: Record<string, Faculty>;
 /**
-* Список помилок для розкладу.
-* @category Schedule
-*
-* @remarks
-* Ключі — числові коди помилок.
-* Значення — опис помилки.
-*
-* Коди помилок:
-* - -200: Не має доступу до сервера або помилка доступу до бази даних
-* - -100: Помилка у роботі модуля, зверніться до розробника
-* - -90: Об`єкт, для якого потрібно показати розклад, не знайдено
-* - -80: Неправильний режим (помилка у параметрі req_mode або req_type)
-* - -70: Помилка у датах
-* - -60: Помилка у параметрах
-* - -7: Зараз відбувається технічне обслуговування бази, робота тимчасово неможлива!
-* - -6: Вигрузка всього розкладу разом заборонена Адмiнiстратором
-* - -5: Технічні роботи на сервері
-* - -4: За даним запитом нічого не знайдено
-* - -3: Перегляд розкладу на вказані дати заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)
-* - -2: Перегляд розкладу заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)
-* - -1: Розклад у базі відсутній
-*/
+ * Список помилок для розкладу.
+ * @category Schedule
+ *
+ * @remarks
+ * Ключі — числові коди помилок.
+ * Значення — опис помилки.
+ *
+ * Коди помилок:
+ * - -200: Не має доступу до сервера або помилка доступу до бази даних
+ * - -100: Помилка у роботі модуля, зверніться до розробника
+ * - -90: Об`єкт, для якого потрібно показати розклад, не знайдено
+ * - -80: Неправильний режим (помилка у параметрі req_mode або req_type)
+ * - -70: Помилка у датах
+ * - -60: Помилка у параметрах
+ * - -7: Зараз відбувається технічне обслуговування бази, робота тимчасово неможлива!
+ * - -6: Вигрузка всього розкладу разом заборонена Адмiнiстратором
+ * - -5: Технічні роботи на сервері
+ * - -4: За даним запитом нічого не знайдено
+ * - -3: Перегляд розкладу на вказані дати заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)
+ * - -2: Перегляд розкладу заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)
+ * - -1: Розклад у базі відсутній
+ */
 export declare const scheduleErrors: Record<number, string>;
 /**
-* Тип розкладу.
-* @category Schedule
-*
-* @remarks
-* Типи: group, teacher, room.
-*/
+ * Тип розкладу.
+ * @category Schedule
+ *
+ * @remarks
+ * Типи: group, teacher, room.
+ */
 export declare const scheduleTypes: Record<string, string>;
 /**
-* Блоки
-* @category Audience
-*/
+ * Блоки
+ * @category Audience
+ */
 export declare const blocks: Record<string, string>;