zdu-student-api 1.1.0

package/README.md

@@ -0,0 +1,162 @@
+# ZDU Student API
+
+API для **Житомирського державного університету імені Івана Франка**.
+
+Бібліотека надає програмний доступ до відкритих сервісів університету, зокрема:
+
+* 📅 розклад занять студентів / викладачів / аудиторій
+* 🚪 зайняті / вільні аудиторії
+* 🏫 списки аудиторій
+* 👥 списки груп
+* 👨‍🏫 списки викладачів
+
+### 🔮 У планах
+
+* API кабінету студента
+* оцінки
+* рейтинги
+
+> ⚠️ Проєкт **не є офіційним** API університету.
+
+---
+
+## Встановлення
+
+```bash
+npm install zdu-student-api
+```
+
+---
+
+## Базове використання
+
+### Отримання розкладу
+
+```ts
+import { Schedule, scheduleErrors } from 'zdu-student-api';
+
+const schedule = new Schedule();
+schedule.group = '23Бд-СОінф123';
+schedule.type = 'group';
+schedule.rosText = true;
+schedule.allStreamComponents = true;
+
+try {
+  const sc = await extraction await schedule.getSchedule();
+  console.log('Розклад:', sc);
+} catch (err: any) {
+  console.error(err.message);
+  console.error(scheduleErrors[JSON.parse(err.message).errorcode]);
+}
+```
+
+---
+
+### Розклад для аудиторії
+
+```ts
+const schedule = new Schedule();
+schedule.roomId = 35;
+schedule.type = 'room';
+schedule.rosText = true;
+
+const sc = await schedule.getSchedule();
+console.log(sc);
+```
+
+---
+
+## Довідкові методи
+
+### Групи
+
+```ts
+import { getGroups } from 'zdu-student-api';
+
+const groups = await getGroups('25Бд-Комп');
+console.log(groups);
+```
+
+---
+
+### Викладачі
+
+```ts
+import { getTeachers } from 'zdu-student-api';
+
+const teachers = await getTeachers('Кривонос Олександр');
+console.log(teachers);
+```
+
+---
+
+### Аудиторії
+
+```ts
+import { getRooms } from 'zdu-student-api';
+
+const rooms = await getRooms('319');
+console.log(rooms);
+```
+
+---
+
+### Типи аудиторій
+
+```ts
+import { getTypesAudience } from 'zdu-student-api';
+
+const types = await getTypesAudience('Ле');
+console.log(types);
+```
+
+---
+
+### Аудиторії за корпусом / гуртожитком
+
+```ts
+import { Audience } from 'zdu-student-api';
+
+const audience = new Audience();
+audience.blockName = 'гуртож №3';
+
+const audiences = await audience.getAudience();
+console.log(audiences);
+```
+
+---
+
+### Додаткові параметри (DOPs)
+
+```ts
+import { getDops } from 'zdu-student-api';
+
+const dops = await getDops();
+console.log(dops);
+```
+
+---
+
+### Кабінет студента (WIP)
+
+```ts
+import { getSesId } from 'zdu-student-api';
+
+const sessionId = await getSesId('LOGIN', 'PASSWORD');
+console.log(sessionId);
+```
+
+> ⚠️ Функціонал у розробці
+
+---
+
+## Документація
+
+📘 API-документація (TypeDoc):
+[https://nicita-3.github.io/zdu-student-api](https://nicita-3.github.io/zdu-student-api)
+
+---
+
+## Ліцензія
+
+MIT © 2025

package/dist/audience/index.js

@@ -0,0 +1 @@
+"use strict";

package/dist/audience.d.ts

@@ -0,0 +1,68 @@
+import { AudienceRoom, Blocks } from './types.ts';
+/**
+ * Клас розкладу
+ * @category Audience
+ */
+export declare class Audience {
+    /**
+    * Назва корпусу
+    */
+    blockName?: Blocks;
+    /**
+    * Номер пари
+    */
+    lesson: number;
+    /**
+    * Тип аудиторій який є в даному корпусі
+    */
+    roomType?: string;
+    /**
+    * Кількість місць не менше ніж
+    */
+    size_min?: number;
+    /**
+    * Кількість місць не більше ніж
+    */
+    size_max?: number;
+    /**
+    * Дата аудиторії
+    */
+    roomsDate: Date;
+    /**
+    * Наявніть доп. обладнання типу 1, 2, 3, 4, 5, 6, 7, 8
+    */
+    dops: number[];
+    /**
+    * Повертає список аудиторій
+    *
+    * @throws {Error} Якщо виникають проблеми з запитом або дані некоректні.
+    *
+    * @example
+    * ```ts
+    * import { Audience } from "./audience.ts";
+    * const audience = new Audience();
+    * try {
+    *   const audiences = await audience.getAudience();
+    *   console.log("Аудиторії:", audiences); // Поверне список аудиторій
+    * } catch (err: any) {
+    *   console.error(err.message);
+    * }
+    * ```
+    *
+    * @remarks
+    * У `err.message` може повертатися простий текст помилки,
+    * або об’єкт у форматі:
+    * ```JSON
+    * {
+    *   "error_message": "Текст помилки",
+    *   "errorcode": "Код помилки"
+    * }
+    * ```
+    *
+    * Де:
+    * - `error_message` - текст помилки відповідно до {@link scheduleErrors}
+    * - `errorcode` - код помилки відповідно до {@link scheduleErrors}
+    */
+    getAudience(): Promise<AudienceRoom[]>;
+    private encodeCP1251;
+}

package/dist/cabinet/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./sesId.ts";
+export * from "./types.ts";

package/dist/cabinet/index.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cabinet/sesId.d.ts

@@ -0,0 +1,9 @@
+import { SessionData } from "./types";
+/**
+ * Отримати sesID та sessGUID користувача
+ * @category Cabinet
+ * @param family - прізвище користувача
+ * @param password - пароль
+ * @returns Об'єкт { sesID, sessGUID }
+ */
+export declare function getSesId(family: string, password: string): Promise<SessionData>;

package/dist/cabinet/types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * sesID та sessGUID користувача
+ * @category Cabinet
+ * @remarks
+ * - `ok` — Успіх отримання токену
+ * - `sesID` — Айді сесії
+ * - `sessGUID` — Унікальний token у cookie для ідентифікації сесії
+ */
+export interface SessionData {
+    ok: boolean;
+    sesID: string;
+    sessGUID: string;
+}

package/dist/constants.d.ts

@@ -0,0 +1,58 @@
+import { Faculty } from './types.ts';
+/**
+* Список факультетів університету.
+* @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: Розклад у базі відсутній
+*/
+export declare const scheduleErrors: Record<number, string>;
+/**
+* Тип розкладу.
+* @category Schedule
+*
+* @remarks
+* Типи: group, teacher, room.
+*/
+export declare const scheduleTypes: Record<string, string>;
+/**
+* Блоки
+* @category Audience
+*/
+export declare const blocks: Record<string, string>;

package/dist/constants.js

@@ -0,0 +1,67 @@
+/**
+ * Список факультетів університету.
+ * - `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 const faculties = {
+    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: "Науковий ліцей" }
+};
+/**
+ * Список помилок для розкладу.
+ *
+ * Ключі — числові коди помилок.
+ * Значення — опис помилки.
+ *
+ * Коди помилок:
+ * - -200: Не має доступу до сервера або помилка доступу до бази даних
+ * - -100: Помилка у роботі модуля, зверніться до розробника
+ * - -90: Об`єкт, для якого потрібно показати розклад, не знайдено
+ * - -80: Неправильний режим (помилка у параметрі req_mode або req_type)
+ * - -70: Помилка у датах
+ * - -60: Помилка у параметрах
+ * - -7: Зараз відбувається технічне обслуговування бази, робота тимчасово неможлива!
+ * - -6: Вигрузка всього розкладу разом заборонена Адмiнiстратором
+ * - -5: Технічні роботи на сервері
+ * - -4: За даним запитом нічого не знайдено
+ * - -3: Перегляд розкладу на вказані дати заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)
+ * - -2: Перегляд розкладу заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)
+ * - -1: Розклад у базі відсутній
+ */
+export const scheduleErrors = {
+    [-200]: "Не має доступу до сервера або помилка доступу до бази даних",
+    [-100]: "Помилка у роботі модуля, зверніться до розробника",
+    [-90]: "Об`єкт, для якого потрібно показати розклад, не знайдено",
+    [-80]: "Неправильний режим (помилка у параметрі req_mode або req_type)",
+    [-70]: "Помилка у датах",
+    [-60]: "Помилка у параметрах",
+    [-7]: "Зараз відбувається технічне обслуговування бази, робота тимчасово неможлива!",
+    [-6]: "Вигрузка всього розкладу разом заборонена Адмiнiстратором",
+    [-5]: "Технічні роботи на сервері",
+    [-4]: "За даним запитом нічого не знайдено",
+    [-3]: "Перегляд розкладу на вказані дати заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)",
+    [-2]: "Перегляд розкладу заблоковано адміністратором (Розклад у процесі складання і ще не готовий для демонстрації)",
+    [-1]: "Розклад у базі відсутній"
+};

package/dist/examples.d.ts

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

package/dist/examples.js

@@ -0,0 +1,3 @@
+import { Schedule } from "./index";
+const schedule = new Schedule();
+console.log((await schedule.getGroups()));

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./schedule.ts";
+export * from "./types.ts";
+export * from "./constants.ts";
+export * from "./utility/groups.ts";
+export * from "./utility/rooms.ts";
+export * from "./utility/teachers.ts";
+export * from "./audience.ts";
+export * from "./utility/types-audience.ts";
+export * from "./utility/dops.ts";
+export * from "./cabinet/index.ts";

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./schedule";
+export * from "./types";
+export * from "./constants";

package/dist/schedule/http.js

@@ -0,0 +1 @@
+"use strict";

package/dist/schedule/index.d.ts

@@ -0,0 +1,64 @@
+import { Faculty } from "../types";
+/**
+ * Клас розкладу
+ */
+export declare class Schedule {
+    /**
+    * Група
+    */
+    group: string;
+    /**
+     * Факультет.
+     *
+     * Можна призначити одну з констант з `faculties`, наприклад:
+     * ```ts
+     * schedule.faculty = faculties.physicsMath;
+     * console.log(schedule.faculty.id);   // 1001
+     * console.log(schedule.faculty.name); // "Фізико-математичний факультет"
+     * ```
+     */
+    faculty: Faculty;
+    /**
+    * Викладач
+    */
+    teacher: string;
+    /**
+    * Курс
+    *
+    * `0` - не вибрано
+    */
+    course: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+    * Початкова дата розкладу
+    */
+    beginDate: Date;
+    /**
+    * Кінцева дата розкладу (за промовчанням +7 днів)
+    */
+    endDate: Date;
+    /**
+    * Показувати пусті дні - false
+    */
+    showEmpty: boolean;
+    /**
+     * false - сформований текст (за промовчанням)
+     * true - окремі стовпчики
+     */
+    private _rosText;
+    /**
+     * Показувати повний склад потоку (тільки для rosText=true)
+     */
+    allStreamComponents: boolean;
+    set rosText(value: boolean);
+    get rosText(): boolean;
+    constructor();
+    /**
+    * Повертає список груп
+    */
+    getGroups(): Promise<string[]>;
+    /**
+    * Повертає список викладачів
+    */
+    getTeachers(): Promise<string[]>;
+    getSchedule(): Promise<string>;
+}

package/dist/schedule/index.js

@@ -0,0 +1,98 @@
+import iconv from 'iconv-lite';
+import fetch from 'node-fetch';
+import { Buffer } from 'buffer';
+import { faculties } from "../constants";
+/**
+ * Клас розкладу
+ */
+export class Schedule {
+    /**
+    * Група
+    */
+    group = '';
+    /**
+     * Факультет.
+     *
+     * Можна призначити одну з констант з `faculties`, наприклад:
+     * ```ts
+     * schedule.faculty = faculties.physicsMath;
+     * console.log(schedule.faculty.id);   // 1001
+     * console.log(schedule.faculty.name); // "Фізико-математичний факультет"
+     * ```
+     */
+    faculty = faculties.none;
+    /**
+    * Викладач
+    */
+    teacher = '';
+    /**
+    * Курс
+    *
+    * `0` - не вибрано
+    */
+    course = 0;
+    /**
+    * Початкова дата розкладу
+    */
+    beginDate = new Date();
+    /**
+    * Кінцева дата розкладу (за промовчанням +7 днів)
+    */
+    endDate = new Date(this.beginDate.getTime() + 7 * 24 * 60 * 60 * 1000);
+    /**
+    * Показувати пусті дні - false
+    */
+    showEmpty = false;
+    /**
+     * false - сформований текст (за промовчанням)
+     * true - окремі стовпчики
+     */
+    _rosText = false;
+    /**
+     * Показувати повний склад потоку (тільки для rosText=true)
+     */
+    allStreamComponents = false;
+    set rosText(value) {
+        this._rosText = value;
+        // Якщо rosText = false, блокувати allStreamComponents
+        if (!value) {
+            this.allStreamComponents = false;
+        }
+    }
+    get rosText() {
+        return this._rosText;
+    }
+    constructor() {
+    }
+    /**
+    * Повертає список груп
+    */
+    async getGroups() {
+        const url = 'https://dekanat.zu.edu.ua/cgi-bin/groups.cgi'; // приклад
+        const response = await fetch(url);
+        const buffer = await response.arrayBuffer(); // отримуємо raw data
+        const text = iconv.decode(Buffer.from(buffer), 'windows-1251'); // конвертуємо в UTF-8
+        // Тут треба парсити текст і витягувати групи, наприклад через регулярки
+        const groups = text.match(/<option value=".*?">(.*?)<\/option>/g)?.map(opt => opt.replace(/<.*?>/g, '').trim()) || [];
+        return groups;
+    }
+    /**
+    * Повертає список викладачів
+    */
+    async getTeachers() {
+        const url = 'https://dekanat.zu.edu.ua/cgi-bin/teachers.cgi';
+        const response = await fetch(url);
+        const buffer = await response.arrayBuffer();
+        const text = iconv.decode(Buffer.from(buffer), 'windows-1251');
+        const teachers = text.match(/<option value=".*?">(.*?)<\/option>/g)?.map(opt => opt.replace(/<.*?>/g, '').trim()) || [];
+        return teachers;
+    }
+    async getSchedule() {
+        const url = `https://dekanat.zu.edu.ua/cgi-bin/timetable_export.cgi?group=${this.group}&faculty=${this.faculty.id}`;
+        const response = await fetch(url);
+        const buffer = await response.arrayBuffer();
+        const text = iconv.decode(Buffer.from(buffer), 'windows-1251');
+        // Тут треба парсити HTML/JSON розкладу
+        return text;
+    }
+}

package/dist/schedule.d.ts

@@ -0,0 +1,117 @@
+import { BaseLesson, DetailedLesson, Faculty, ScheduleTypes } from './types.ts';
+/**
+ * Клас розкладу
+ * @category Schedule
+ */
+export declare class Schedule {
+    /**
+    * Тип розкладу.
+    *
+    * Типи: group, teacher, room.
+    */
+    type: ScheduleTypes;
+    /**
+    * Група
+    */
+    group: string;
+    /**
+    * Id групи
+    */
+    groupId?: number;
+    /**
+    * Викладач
+    */
+    teacher: string;
+    /**
+    * Id викладача
+    */
+    teacherId?: number;
+    /**
+    * Аудиторія
+    */
+    room: string;
+    /**
+    * Id аудиторії
+    */
+    roomId?: number;
+    /**
+     * Факультет.
+     *
+     * @example
+     * Можна призначити одну з констант з `faculties`, наприклад:
+     * ```ts
+     * schedule.faculty = faculties.physicsMath;
+     * console.log(schedule.faculty.id);   // 1001
+     * console.log(schedule.faculty.name); // 'Фізико-математичний факультет'
+     * ```
+     */
+    faculty: Faculty;
+    /**
+    * Курс
+    *
+    * `0` - не вибрано
+    */
+    course: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+    * Початкова дата розкладу
+    */
+    beginDate: Date;
+    /**
+    * Кінцева дата розкладу (за промовчанням +7 днів)
+    */
+    endDate: Date;
+    /**
+    * Показувати пусті дні - false
+    */
+    showEmpty: boolean;
+    /**
+     * false - сформований текст (за промовчанням)
+     * true - окремі стовпчики
+     */
+    private _rosText;
+    /**
+     * Показувати повний склад потоку (тільки для rosText=true)
+     */
+    allStreamComponents: boolean;
+    set rosText(value: boolean);
+    get rosText(): boolean;
+    /**
+    * Повертає список пар (розклад)
+    *
+    * @throws {Error} Якщо виникають проблеми з запитом або дані некоректні.
+    *
+    * @example
+    * ```ts
+    * import { Schedule, scheduleErrors } from "./index.ts";
+    * const schedule = new Schedule();
+    * schedule.group = '23Бд-СОінф123' // встановлюєм неправильну назву групи
+    * schedule.type = 'group' // встановлєм тип пошуку по групі
+    * schedule.rosText = true; // встановлюєм окремі стовпчики
+    * schedule.allStreamComponents = true; // встановлюєм повний склад потоку
+    * try {
+    *   const mySchedule = await schedule.getSchedule();
+    *   console.log("Розклад:", mySchedule);
+    * } catch (err: any) {
+    *   // Отримуєм помилку тому що ми неправильно вказали назву групи
+    *   console.error(err.message); // Поверне: "{"error_message":"Об‘єкт - 23Бд-СОінф123 - Об‘єкт не знайдено  ","errorcode":"-90"}"
+    *   console.error(scheduleErrors[JSON.parse(err.message).errorcode]); // Поверне: "Об`єкт, для якого потрібно показати розклад, не знайдено"
+    * }
+    * ```
+    *
+    * @remarks
+    * У `err.message` може повертатися простий текст помилки,
+    * або об’єкт у форматі:
+    * ```JSON
+    * {
+    *   "error_message": "Текст помилки",
+    *   "errorcode": "Код помилки"
+    * }
+    * ```
+    *
+    * Де:
+    * - `error_message` - текст помилки відповідно до {@link scheduleErrors}
+    * - `errorcode` - код помилки відповідно до {@link scheduleErrors}
+    */
+    getSchedule(): Promise<DetailedLesson[] | BaseLesson[]>;
+    private encodeCP1251;
+}

package/dist/types.d.ts

@@ -0,0 +1,160 @@
+/**
+ * Факультет
+ * @category Schedule
+ *
+ * @remarks
+ * - `id` — Числовий ідентифікатор факультету
+ * - `name` — Повна назва факультету
+ */
+export interface Faculty {
+    name: string;
+    id: number;
+}
+/**
+ * Група
+ * @category Schedule
+ *
+ * @remarks
+ * - `name` — Повна назва групи
+ * - `id` — Ідентифікатор групи
+ * - `faculty` — Повна назва факультету
+ */
+export interface Group {
+    name: string;
+    id: string;
+    faculty: string;
+}
+/**
+ * Викладач
+ * @category Schedule
+ *
+ * @remarks
+ * - `name` — Ім'я викладача в форматі Прізвище І.П.
+ * - `id` — Ідентифікатор викладача
+ * - `faculty` — Повна назва факультету
+ * - `surname` — Прізвище
+ * - `firstname` — Ім'я
+ * - `lastname` — По батькові
+ */
+export interface Teacher {
+    name: string;
+    id: string;
+    faculty: string;
+    surname: string;
+    firstname: string;
+    lastname: string;
+}
+/**
+ * Аудиторія
+ * @category Schedule
+ *
+ * @remarks
+ * - `name` — Назва аудиторії
+ * - `id` — Ідентифікатор аудиторії
+ * - `block` — Назва блоку (гуртожиток/корпус), до якого належить аудиторія
+ */
+export interface Room {
+    name: string;
+    id: string;
+    block: string;
+}
+/**
+* Типи для отримання розкладу.
+* @category Schedule
+*
+*/
+export type ScheduleTypes = 'group' | 'teacher' | 'room';
+/**
+ * Базова інформація про заняття
+ * @category Schedule
+ *
+ * @remarks
+ * - `object` — Назва групи, аудиторія, викладач
+ * - `date` — Дата проведення заняття у форматі DD.MM.YYYY
+ * - `comment` — Коментар до заняття
+ * - `lesson_number` — Номер пари за розкладом (1–6)
+ * - `lesson_name` — Назва пари
+ * - `lesson_time` — Час проведення пари, наприклад "10:30-11:50"
+ * - `lesson_description` — Повний текстовий опис пари (rosText = false)
+ * - `stream_components` — ID груп потоку (цифрові коди), через кому
+ */
+export interface BaseLesson {
+    object: string;
+    date: string;
+    comment: string;
+    lesson_number: string;
+    lesson_name: string;
+    lesson_time: string;
+    lesson_description?: string;
+    stream_components?: string;
+}
+/**
+ * Детальна інформація про заняття
+ * Розділена на окремі поля (rosText = true)
+ * @category Schedule
+ *
+ * @remarks
+ * - `half` — Номер підгрупи
+ * - `teacher` — Основний викладач
+ * - `teachers_add` — Додаткові викладачі
+ * - `room` — Аудиторія, наприклад "319/№1"
+ * - `group` — Список груп, які відвідують заняття
+ * - `title` — Повна назва предмету або його код
+ * - `type` — Тип заняття
+ * - `replacement` — Позначка про заміну пари
+ * - `online` — Чи є онлайн-посилання / онлайн-режим
+ * - `comment4link` — Коментар до посилання (іноді використовується для Zoom/Meet)
+ * - `link` — Посилання на онлайн-заняття
+ */
+export interface DetailedLesson extends BaseLesson {
+    half: string;
+    teacher: string;
+    teachers_add: string;
+    room: string;
+    group: string;
+    title: string;
+    type: string;
+    replacement: string;
+    reservation: string;
+    online: string;
+    comment4link: string;
+    link: string;
+}
+/**
+ * Аудиторія
+ * @category Audience
+ *
+ * @remarks
+ * - `name` — Назва аудиторії
+ * - `block` — Назва блоку
+ * - `type` — Тип аудиторії
+ * - `places` — Кількість місць
+ * - `comment` — Коментар до аудиторії
+ */
+export interface AudienceRoom {
+    name: string;
+    block: string;
+    type: string;
+    places: string;
+    comment: string;
+}
+/**
+* Блоки
+* @category Audience
+*/
+export type Blocks = '' | '№1' | '№2' | '№3' | '№4' | '№5' | 'гуртож №1' | 'гуртож №2' | 'гуртож №3' | 'гуртож №4' | 'гуртож №5';
+/**
+* Тип аудиторії
+* @category Audience
+*/
+export interface TypeAudience {
+    full: string;
+    short: string;
+}
+/**
+* Доп. обладнання
+* @category Audience
+*/
+export interface Dop {
+    name: string;
+}

package/dist/types.js

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

package/dist/utility/dops.d.ts

@@ -0,0 +1,27 @@
+import { Dop } from "../types.ts";
+/**
+* Повертає список доп. обладнання аудиторій
+* @category Utility
+*
+* @param query - Рядок пошуку доп. обладнання
+* @returns Масив доп. обладнання
+*
+* @deprecated Ця функція не використовується і повертає безкорисливі данні.
+*
+* @example
+* ```ts
+* console.log((await getDops()));
+* ```
+*
+* @remarks
+* Виведе:
+* ```JSON
+* [
+*   {
+*       name: 'Не використовується',
+*       ...
+*   }
+* ]
+* ```
+*/
+export declare function getDops(query?: string): Promise<Dop[]>;

package/dist/utility/groups.d.ts

@@ -0,0 +1,26 @@
+import { Group } from "../types.ts";
+/**
+* Повертає список груп
+* @category Utility
+*
+* @param query - Рядок пошуку групи
+* @returns Масив груп
+*
+* @example
+* ```ts
+* console.log((await getGroups('23Бд-СОінф')));
+* ```
+*
+* @remarks
+* Виведе:
+* ```JSON
+* [
+*   {
+*       name: '23Бд-СОінф',
+*       id: '-3158',
+*       faculty: 'Фізико-математичний факультет'
+*   }
+* ]
+* ```
+*/
+export declare function getGroups(query?: string): Promise<Group[]>;

package/dist/utility/rooms.d.ts

@@ -0,0 +1,23 @@
+import { Room } from "../types.ts";
+/**
+* Повертає список аудиторій
+* @category Utility
+*
+* @param query - Рядок пошуку аудиторії
+* @returns Масив аудиторій
+*
+* @example
+* ```ts
+* console.log((await getRooms('319')));
+* ```
+*
+* @remarks
+* Виведе:
+* ```JSON
+* [
+*   { name: '319/№1', id: '35', block: '№1' },
+*   { name: '319/№3', id: '270', block: '№3' }
+* ]
+* ```
+*/
+export declare function getRooms(query?: string): Promise<Room[]>;

package/dist/utility/teachers.d.ts

@@ -0,0 +1,29 @@
+import { Teacher } from "../types.ts";
+/**
+* Повертає список викладачів
+* @category Utility
+*
+* @param query - Рядок пошуку викладача
+* @returns Масив викладачів
+*
+* @example
+* ```ts
+* console.log((await getTeachers('Кривонос Олександр')));
+* ```
+*
+* @remarks
+* Виведе:
+* ```JSON
+* [
+*   {
+*       name: 'Кривонос О.М.',
+*       id: '420',
+*       faculty: 'Кафедра комп’ютерних наук та інформаційних технологій',
+*       surname: 'Кривонос',
+*       firstname: 'Олександр',
+*       lastname: 'Миколайович'
+*   }
+* ]
+* ```
+*/
+export declare function getTeachers(query?: string): Promise<Teacher[]>;

package/dist/utility/types-audience.d.ts

@@ -0,0 +1,25 @@
+import { TypeAudience } from "../types.ts";
+/**
+* Повертає список типів аудиторій
+* @category Utility
+*
+* @param query - Рядок пошуку типу
+* @returns Масив типів аудиторій
+*
+* @example
+* ```ts
+* console.log((await getTypesAudience('Ле')));
+* ```
+*
+* @remarks
+* Виведе:
+* ```JSON
+* [
+*   {
+*       full: 'Лекція',
+*       short: 'лек'
+*   }
+* ]
+* ```
+*/
+export declare function getTypesAudience(query?: string): Promise<TypeAudience[]>;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "zdu-student-api",
+  "version": "1.1.0",
+  "description": "API client for ZDU student services",
+  "author": "Nicita3 <ni596157@gmail.com> (https://github.com/Nicita-3)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "docs": "typedoc --out docs src",
+    "test": "node --loader ts-node/esm src/examples.ts"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Nicita-3/zdu-student-api"
+  },
+  "homepage": "https://nicita-3.github.io/zdu-student-api",
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.14",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "buffer": "^6.0.3",
+    "iconv-lite": "^0.7.0",
+    "node-fetch": "^3.3.2"
+  }
+}