zdu-student-api 1.1.5 → 1.1.7

package/dist/schedule.js

@@ -7,34 +7,34 @@ import { faculties } from './constants.js';
  */
 export class Schedule {
     /**
-    * Тип розкладу.
-    *
-    * Типи: group, teacher, room.
-    */
+     * Тип розкладу.
+     *
+     * Типи: group, teacher, room.
+     */
     type = 'group';
     /**
-    * Група
-    */
+     * Група
+     */
     group = '';
     /**
-    * Id групи
-    */
+     * Id групи
+     */
     groupId;
     /**
-    * Викладач
-    */
+     * Викладач
+     */
     teacher = '';
     /**
-    * Id викладача
-    */
+     * Id викладача
+     */
     teacherId;
     /**
-    * Аудиторія
-    */
+     * Аудиторія
+     */
     room = '';
     /**
-    * Id аудиторії
-    */
+     * Id аудиторії
+     */
     roomId;
     /**
      * Факультет.
@@ -49,22 +49,22 @@ export class Schedule {
      */
     faculty = faculties.none;
     /**
-    * Курс
-    *
-    * `0` - не вибрано
-    */
+     * Курс
+     *
+     * `0` - не вибрано
+     */
     course = 0;
     /**
-    * Початкова дата розкладу
-    */
+     * Початкова дата розкладу
+     */
     beginDate = new Date();
     /**
-    * Кінцева дата розкладу (за промовчанням +7 днів)
-    */
+     * Кінцева дата розкладу (за промовчанням +7 днів)
+     */
     endDate = new Date(this.beginDate.getTime() + 7 * 24 * 60 * 60 * 1000);
     /**
-    * Показувати пусті дні - false
-    */
+     * Показувати пусті дні - false
+     */
     showEmpty = false;
     /**
      * false - сформований текст (за промовчанням)
@@ -84,69 +84,75 @@ export class Schedule {
         return this._rosText;
     }
     /**
-    * Повертає список пар (розклад)
-    *
-    * @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}
-    */
+     * Повертає список пар (розклад)
+     *
+     * @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}
+     */
     async getSchedule() {
         const beginDate = this.beginDate.toLocaleDateString('uk-UA', {
             day: '2-digit',
             month: '2-digit',
-            year: 'numeric'
+            year: 'numeric',
         });
         const endDate = this.endDate.toLocaleDateString('uk-UA', {
             day: '2-digit',
             month: '2-digit',
-            year: 'numeric'
+            year: 'numeric',
         });
-        let id = (this.type === 'group' ? this.groupId : this.type === 'teacher' ? this.teacherId : this.roomId);
+        let id = this.type === 'group'
+            ? this.groupId
+            : this.type === 'teacher'
+                ? this.teacherId
+                : this.roomId;
         if (!id)
             id = '';
-        let name = (this.type === 'group' ? this.group : this.type === 'teacher' ? this.teacher : this.room);
+        let name = this.type === 'group' ? this.group : this.type === 'teacher' ? this.teacher : this.room;
         name = this.encodeCP1251(name);
         const response = await fetch(`https://dekanat.zu.edu.ua/cgi-bin/timetable_export.cgi?req_type=rozklad&req_mode=${this.type}&OBJ_ID=${id}&OBJ_name=${name}&dep_name=&begin_date=${beginDate}&end_date=${endDate}&ros_text=${this.rosText ? 'separated' : 'united'}${this.showEmpty ? '' : '&show_empty=yes'}${this.allStreamComponents ? '' : '&all_stream_components=yes'}&req_format=json&coding_mode=UTF8&bs=%D1%F4%EE%F0%EC%F3%E2%E0%F2%E8+%E7%E0%EF%E8%F2`);
         if (!response.ok)
             throw new Error(`HTTP error ${response.status}: ${response.statusText}`);
         const data = await response.json();
         if (data.psrozklad_export.code !== '0') {
-            throw new Error(JSON.stringify(data.psrozklad_export.error) || "Unknown error");
+            throw new Error(JSON.stringify(data.psrozklad_export.error) || 'Unknown error');
         }
         return data.psrozklad_export.roz_items;
     }
     encodeCP1251(str) {
         const buf = iconv.encode(str, 'win1251');
-        return Array.from(buf).map(b => '%' + b.toString(16).toUpperCase().padStart(2, '0')).join('');
+        return Array.from(buf)
+            .map((b) => '%' + b.toString(16).toUpperCase().padStart(2, '0'))
+            .join('');
     }
 }

package/dist/types.d.ts

@@ -59,10 +59,10 @@ export interface Room {
     block: string;
 }
 /**
-* Типи для отримання розкладу.
-* @category Schedule
-*
-*/
+ * Типи для отримання розкладу.
+ * @category Schedule
+ *
+ */
 export type ScheduleTypes = 'group' | 'teacher' | 'room';
 /**
  * Базова інформація про заняття
@@ -94,16 +94,17 @@ export interface BaseLesson {
  * @category Schedule
  *
  * @remarks
- * - `half` — Номер підгрупи
+ * - `half` — Половина пари (не використовується)
  * - `teacher` — Основний викладач
  * - `teachers_add` — Додаткові викладачі
  * - `room` — Аудиторія, наприклад "319/№1"
- * - `group` — Список груп, які відвідують заняття
+ * - `group` — Список груп, які відвідують заняття / підгрупа
  * - `title` — Повна назва предмету або його код
  * - `type` — Тип заняття
  * - `replacement` — Позначка про заміну пари
+ * - `reservation` — Зарезервована пара
  * - `online` — Чи є онлайн-посилання / онлайн-режим
- * - `comment4link` — Коментар до посилання (іноді використовується для Zoom/Meet)
+ * - `comment4link` — Коментар до посилання (іноді використовується для Zoom/Meet) / підгрупа / коментар
  * - `link` — Посилання на онлайн-заняття
  */
 export interface DetailedLesson extends BaseLesson {
@@ -139,22 +140,22 @@ export interface AudienceRoom {
     comment: string;
 }
 /**
-* Блоки
-* @category Audience
-*/
+ * Блоки
+ * @category Audience
+ */
 export type Blocks = '' | '№1' | '№2' | '№3' | '№4' | '№5' | 'гуртож №1' | 'гуртож №2' | 'гуртож №3' | 'гуртож №4' | 'гуртож №5';
 /**
-* Тип аудиторії
-* @category Audience
-*/
+ * Тип аудиторії
+ * @category Audience
+ */
 export interface TypeAudience {
     full: string;
     short: string;
 }
 /**
-* Доп. обладнання
-* @category Audience
-*/
+ * Доп. обладнання
+ * @category Audience
+ */
 export interface Dop {
     name: string;
 }

package/dist/types.js

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

package/package.json

@@ -1,35 +1,37 @@
 {
-  "name": "zdu-student-api",
-  "version": "1.1.5",
-  "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",
-    "publish:all": "npm run build && npm run docs && npm publish"
-  },
-  "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",
-    "cross-fetch": "^4.1.0",
-    "iconv-lite": "^0.7.0"
-  }
+    "name": "zdu-student-api",
+    "version": "1.1.7",
+    "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",
+        "publish:all": "npm run build && npm run docs && npm publish"
+    },
+    "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",
+        "prettier": "^3.7.4",
+        "ts-node": "^10.9.2",
+        "typedoc": "^0.28.14",
+        "typescript": "^5.9.3"
+    },
+    "dependencies": {
+        "buffer": "^6.0.3",
+        "cross-fetch": "^4.1.0",
+        "dotenv": "^17.2.3",
+        "iconv-lite": "^0.7.0"
+    }
 }