nazar-salary 3.4.3 → 3.4.5

package/index.d.ts

@@ -818,7 +818,10 @@ declare module 'nazar-salary' {
 
   export interface DashboardKpi {
     students: {
+      /** Students whose latest course record is active (excludes deleted students) */
       active: number;
+      /** Students whose latest course record is closed — finished, stopped or refunded (excludes deleted students) */
+      inactive: number;
       new_this_month: number;
       finished_this_month: number;
     };
@@ -1061,6 +1064,7 @@ declare module 'nazar-salary' {
       date_to?: string;
       display: string;
     };
+    /** Totals for the requested period (respects period/status/teacher_id filters) */
     summary: {
       total_teachers: number;
       total_payments: number;
@@ -1071,6 +1075,21 @@ declare module 'nazar-salary' {
         paid: number;
       };
     };
+    /**
+     * Lesson totals as of now — a snapshot, NOT limited by period/status
+     * (student_history has no per-lesson dates). Respects teacher_id if passed.
+     * Deleted students are excluded.
+     */
+    lessons_summary: {
+      /** Lessons conducted across all courses ever (finished and stopped included) */
+      completed_lessons: number;
+      /** Lessons still to be conducted — active courses only */
+      remaining_lessons: number;
+      /** completed_lessons valued at the current price (rate_per_lesson) */
+      completed_amount: number;
+      /** remaining_lessons valued at the current price — future teacher payout */
+      remaining_amount: number;
+    };
     teachers: TeacherSalaryItem[];
   }
 
@@ -1727,9 +1746,10 @@ declare module 'nazar-salary' {
     // Forecast endpoints
     /**
      * Get teacher salary forecast for upcoming months (Admin only)
-     * @param monthsAhead Number of months to forecast (1–12). Default: 6
+     * @param monthsAhead Number of forecast months (1–12). Default: 6
+     * @param monthsBefore Number of past months prepended to monthly_data (0–12). Default: 4
      */
-    getTeacherExpensesForecast(monthsAhead?: number): Promise<TeacherExpensesForecastResponse>;
+    getTeacherExpensesForecast(monthsAhead?: number, monthsBefore?: number): Promise<TeacherExpensesForecastResponse>;
 
     // Export endpoints
     /**
@@ -1854,6 +1874,10 @@ declare module 'nazar-salary' {
     forecast_metadata: {
       generated_at: string;
       current_month: string;
+      /** How many past months are prepended to monthly_data */
+      previous_months: number;
+      /** Earliest month present in monthly_data (current_month minus previous_months) */
+      data_from: string;
       forecast_period_months: number;
       forecast_from: string;
       forecast_to: string;
@@ -1867,6 +1891,7 @@ declare module 'nazar-salary' {
       min_month: string | null;
       max_month: string | null;
     };
+    /** First entry is the previous month (see forecast_metadata.previous_month), then the forecast window from current_month onward. summary/risk_analysis cover the forecast window only. */
     monthly_data: Array<{
       month: string;
       month_display: string;

package/index.js

@@ -362,7 +362,14 @@ class SalaryAPI {
    * @param {string} [params.date_to] - End date YYYY-MM-DD (required if period_type=custom)
    * @param {string} [params.status] - Filter by status: 'not_paid', 'pending', 'paid'
    * @param {number} [params.teacher_id] - Filter by teacher ID
-   * @returns {Promise<{period: object, summary: object, teachers: array}>}
+   *
+   * Response also carries `lessons_summary` — a snapshot as of now (NOT limited by
+   * period/status; respects teacher_id, excludes deleted students):
+   *   completed_lessons  — lessons conducted across all courses ever
+   *   remaining_lessons  — lessons still to conduct (active courses only)
+   *   completed_amount   — completed_lessons x current rate_per_lesson
+   *   remaining_amount   — remaining_lessons x current rate_per_lesson (future payout)
+   * @returns {Promise<{period: object, summary: object, lessons_summary: object, teachers: array}>}
    */
   async getTeachersSalary(params) {
     return await this.client.get("/api/v1/admin/salary/teachers", { params });
@@ -1033,12 +1040,13 @@ class SalaryAPI {
 
   /**
    * Get teacher salary forecast for upcoming months (Admin only)
-   * @param {number} [monthsAhead=6] - Number of months to forecast (1-12)
+   * @param {number} [monthsAhead=6] - Number of forecast months (1-12)
+   * @param {number} [monthsBefore=4] - Number of past months to prepend to monthly_data (0-12)
    * @returns {Promise<object>}
    */
-  async getTeacherExpensesForecast(monthsAhead = 6) {
+  async getTeacherExpensesForecast(monthsAhead = 6, monthsBefore = 4) {
     return await this.client.get("/api/v1/forecast/teacher-expenses", {
-      params: { months_ahead: monthsAhead },
+      params: { months_ahead: monthsAhead, months_before: monthsBefore },
     });
   }
 

package/package.json

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