@blackcode_sa/metaestetics-api 1.13.0 → 1.13.2

package/src/types/analytics/analytics.types.ts

@@ -32,6 +32,11 @@ export interface AnalyticsFilters {
  */
 export type GroupingPeriod = 'day' | 'week' | 'month';
 
+/**
+ * Trend period type (only predefined periods, no custom)
+ */
+export type TrendPeriod = 'week' | 'month' | 'quarter' | 'year';
+
 /**
  * Entity type for grouping analytics
  */
@@ -143,6 +148,9 @@ export interface CancellationMetrics {
     count: number;
     percentage: number;
   }>;
+  // Practitioner info when grouping by procedure
+  practitionerId?: string;
+  practitionerName?: string;
 }
 
 /**
@@ -156,6 +164,9 @@ export interface NoShowMetrics {
   totalAppointments: number;
   noShowAppointments: number;
   noShowRate: number; // percentage
+  // Practitioner info when grouping by procedure
+  practitionerId?: string;
+  practitionerName?: string;
 }
 
 /**
@@ -181,12 +192,20 @@ export interface RevenueMetrics {
  * Revenue data over time
  */
 export interface RevenueTrend {
-  period: string; // e.g., "2024-01-01", "2024-W01", "2024-01"
+  period: string; // e.g., "2024-W01", "2024-01", "2024-Q1", "2024"
   startDate: Date;
   endDate: Date;
   revenue: number;
   appointmentCount: number;
   averageRevenue: number;
+  currency?: string;
+  // Trend comparison (compared to previous period)
+  previousPeriod?: {
+    revenue: number;
+    appointmentCount: number;
+    percentageChange: number;
+    direction: 'up' | 'down' | 'stable';
+  };
 }
 
 /**
@@ -201,6 +220,84 @@ export interface DurationTrend {
   averageActualDuration: number; // minutes
   averageEfficiency: number; // percentage
   appointmentCount: number;
+  // Trend comparison (compared to previous period)
+  previousPeriod?: {
+    averageBookedDuration: number;
+    averageActualDuration: number;
+    averageEfficiency: number;
+    efficiencyPercentageChange: number;
+    direction: 'up' | 'down' | 'stable';
+  };
+}
+
+/**
+ * Appointment Count Trend
+ * Appointment count trends over time
+ */
+export interface AppointmentTrend {
+  period: string;
+  startDate: Date;
+  endDate: Date;
+  totalAppointments: number;
+  completedAppointments: number;
+  canceledAppointments: number;
+  noShowAppointments: number;
+  pendingAppointments: number;
+  confirmedAppointments: number;
+  // Trend comparison (compared to previous period)
+  previousPeriod?: {
+    totalAppointments: number;
+    completedAppointments: number;
+    percentageChange: number;
+    direction: 'up' | 'down' | 'stable';
+  };
+}
+
+/**
+ * Cancellation Rate Trend
+ * Cancellation and no-show rate trends over time
+ */
+export interface CancellationRateTrend {
+  period: string;
+  startDate: Date;
+  endDate: Date;
+  cancellationRate: number; // percentage
+  noShowRate: number; // percentage
+  totalAppointments: number;
+  canceledAppointments: number;
+  noShowAppointments: number;
+  // Trend comparison (compared to previous period)
+  previousPeriod?: {
+    cancellationRate: number;
+    noShowRate: number;
+    cancellationRateChange: number;
+    noShowRateChange: number;
+    direction: 'up' | 'down' | 'stable';
+  };
+}
+
+/**
+ * Review Trend
+ * Review rating and recommendation trends over time
+ */
+export interface ReviewTrend {
+  period: string; // e.g., "2024-W01", "2024-01", "2024-Q1", "2024"
+  startDate: Date;
+  endDate: Date;
+  averageRating: number; // weighted average rating (0-5)
+  recommendationRate: number; // percentage
+  totalReviews: number;
+  practitionerAverage?: number; // if tracking practitioner reviews
+  procedureAverage?: number; // if tracking procedure reviews
+  // Trend comparison (compared to previous period)
+  previousPeriod?: {
+    averageRating: number;
+    recommendationRate: number;
+    percentageChange: number; // for average rating
+    direction: 'up' | 'down' | 'stable';
+  };
+  entityId?: string; // if grouped by entity
+  entityName?: string;
 }
 
 /**

package/src/types/analytics/grouped-analytics.types.ts

@@ -10,6 +10,20 @@ export interface GroupedAnalyticsBase {
   entityType: EntityType;
 }
 
+/**
+ * Review metrics for grouped analytics
+ * Note: This is a simplified version for grouped analytics.
+ * For full review analytics, see ReviewAnalyticsService.ReviewMetrics
+ */
+export interface ReviewMetrics {
+  totalReviews: number;
+  averageRating: number;
+  recommendationRate: number; // % that would recommend
+  // Comparison to overall average
+  ratingDifference?: number; // Positive = above average, negative = below
+  recommendationDifference?: number; // % difference
+}
+
 /**
  * Grouped Revenue Metrics
  * Revenue analytics grouped by clinic, practitioner, procedure, or patient
@@ -24,6 +38,11 @@ export interface GroupedRevenueMetrics extends GroupedAnalyticsBase {
   refundedRevenue: number;
   totalTax: number;
   totalSubtotal: number;
+  // Practitioner info when grouping by procedure
+  practitionerId?: string;
+  practitionerName?: string;
+  // Review metrics (optional)
+  reviewMetrics?: ReviewMetrics;
 }
 
 /**
@@ -44,6 +63,9 @@ export interface GroupedProductUsageMetrics extends GroupedAnalyticsBase {
     totalRevenue: number;
     usageCount: number;
   }>;
+  // Practitioner info when grouping by procedure
+  practitionerId?: string;
+  practitionerName?: string;
 }
 
 /**
@@ -77,6 +99,9 @@ export interface GroupedTimeEfficiencyMetrics extends GroupedAnalyticsBase {
   totalUnderutilization: number; // minutes
   averageOverrun: number; // minutes
   averageUnderutilization: number; // minutes
+  // Practitioner info when grouping by procedure
+  practitionerId?: string;
+  practitionerName?: string;
 }
 
 /**