nazar-salary 3.2.6 → 3.2.8

package/index.d.ts

@@ -666,6 +666,8 @@ declare module 'nazar-salary' {
     operation_number?: string;
     purchase_amount?: number;
     prepayment?: boolean;
+    /** Unix timestamp (ms) — дата записи студента */
+    created_at?: number;
   }
 
   export interface TransferStudentData {
@@ -1613,7 +1615,58 @@ declare module 'nazar-salary' {
     createRefund(studentId: number, data: CreateRefundData): Promise<CreateRefundResponse>;
     getRefunds(params?: RefundsListParams): Promise<RefundsListResponse>;
 
+    // Forecast endpoints
+    /**
+     * Get teacher salary forecast for upcoming months (Admin only)
+     * @param monthsAhead Number of months to forecast (1–12). Default: 6
+     */
+    getTeacherExpensesForecast(monthsAhead?: number): Promise<TeacherExpensesForecastResponse>;
+
     // Custom request
     request(method: string, path: string, data?: any): Promise<any>;
   }
+
+  export interface TeacherExpensesForecastResponse {
+    status: string;
+    forecast_metadata: {
+      generated_at: string;
+      current_month: string;
+      forecast_period_months: number;
+      forecast_from: string;
+      forecast_to: string;
+      active_students_count: number;
+    };
+    summary: {
+      total_forecast_amount: number;
+      average_monthly_salary: number;
+      min_month_salary: number;
+      max_month_salary: number;
+      min_month: string | null;
+      max_month: string | null;
+    };
+    monthly_data: Array<{
+      month: string;
+      month_display: string;
+      total_salary: number;
+      forecast_salary: number;
+      real_salary: number | null;
+      students_count: number;
+      students: Array<{
+        student_id: number;
+        student_name: string;
+        teacher_id: number;
+        enrollment_months: number;
+        lessons_per_month: number;
+        rate_per_lesson: number;
+        monthly_salary: number;
+        remaining_months: number;
+      }>;
+    }>;
+    risk_analysis: {
+      trend: 'declining' | 'stable' | 'growing';
+      risk_level: 'low' | 'medium' | 'high';
+      warning_message: string;
+      recommended_action: string;
+    };
+  }
 }

package/index.js

@@ -564,6 +564,7 @@ class SalaryAPI {
     * @param {string} [data.operation_number] - Operation number (must be sent with purchase_amount)
     * @param {number} [data.purchase_amount] - Purchase amount (must be sent with operation_number)
    * @param {boolean} [data.prepayment] - Prepayment flag
+   * @param {number} [data.created_at] - Unix timestamp (ms) — дата записи студента
    * @returns {Promise<object>}
    */
   async updateStudent(studentId, data) {
@@ -976,6 +977,19 @@ class SalaryAPI {
     return await this.client.get('/api/v1/admin/refunds', { params });
   }
 
+  // ===== FORECAST ENDPOINTS =====
+
+  /**
+   * Get teacher salary forecast for upcoming months (Admin only)
+   * @param {number} [monthsAhead=6] - Number of months to forecast (1-12)
+   * @returns {Promise<object>}
+   */
+  async getTeacherExpensesForecast(monthsAhead = 6) {
+    return await this.client.get("/api/v1/forecast/teacher-expenses", {
+      params: { months_ahead: monthsAhead },
+    });
+  }
+
   // ===== CUSTOM REQUEST =====
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nazar-salary",
-  "version": "3.2.6",
+  "version": "3.2.8",
   "description": "Frontend library for Nazar Salary API",
   "main": "index.js",
   "types": "index.d.ts",