@blackcode_sa/metaestetics-api 1.13.5 → 1.13.6

package/src/services/analytics/analytics-cloud.service.ts

@@ -1,222 +1,222 @@
-import { Functions, getFunctions, httpsCallable } from 'firebase/functions';
-import { FirebaseApp } from 'firebase/app';
-import {
-  AnalyticsDateRange,
-  AnalyticsFilters,
-  EntityType,
-} from '../../types/analytics';
-
-/**
- * Request data for on-demand analytics calculation
- */
-interface CalculateAnalyticsRequest {
-  analyticsType:
-    | 'dashboard'
-    | 'practitioner'
-    | 'procedure'
-    | 'clinic'
-    | 'timeEfficiency'
-    | 'revenue'
-    | 'cancellation'
-    | 'noShow'
-    | 'productUsage'
-    | 'patient'
-    | 'revenueByEntity'
-    | 'productUsageByEntity'
-    | 'timeEfficiencyByEntity'
-    | 'patientBehaviorByEntity';
-  filters?: AnalyticsFilters;
-  dateRange?: {
-    start: string; // ISO date string
-    end: string; // ISO date string
-  };
-  entityId?: string;
-  groupBy?: EntityType;
-  options?: {
-    storeInCache?: boolean;
-    useCache?: boolean;
-    maxCacheAgeHours?: number;
-  };
-}
-
-/**
- * Response from on-demand analytics calculation
- */
-interface CalculateAnalyticsResponse {
-  success: boolean;
-  data: any;
-  computedAt: string;
-}
-
-/**
- * Client-side service for calling analytics Cloud Functions
- * 
- * This service provides a convenient way to trigger on-demand analytics
- * calculations via Cloud Functions, which can be faster and more efficient
- * than calculating on the client.
- */
-export class AnalyticsCloudService {
-  private functions: Functions;
-
-  /**
-   * Creates a new AnalyticsCloudService instance
-   *
-   * @param app - Firebase App instance
-   * @param region - Functions region (default: 'europe-west6')
-   */
-  constructor(app: FirebaseApp, region: string = 'europe-west6') {
-    this.functions = getFunctions(app, region);
-  }
-
-  /**
-   * Calls the Cloud Function to calculate analytics on-demand
-   *
-   * @param request - Analytics calculation request
-   * @returns Promise resolving to the calculated analytics data
-   */
-  async calculateOnDemand(request: CalculateAnalyticsRequest): Promise<any> {
-    const callable = httpsCallable<CalculateAnalyticsRequest, CalculateAnalyticsResponse>(
-      this.functions,
-      'calculateAnalyticsOnDemand',
-    );
-
-    const response = await callable(request);
-
-    if (!response.data.success) {
-      throw new Error('Analytics calculation failed');
-    }
-
-    return response.data.data;
-  }
-
-  /**
-   * Calculate dashboard analytics on-demand
-   */
-  async calculateDashboard(
-    filters: AnalyticsFilters,
-    dateRange: AnalyticsDateRange,
-    options?: { storeInCache?: boolean },
-  ) {
-    return this.calculateOnDemand({
-      analyticsType: 'dashboard',
-      filters,
-      dateRange: {
-        start: dateRange.start.toISOString(),
-        end: dateRange.end.toISOString(),
-      },
-      options,
-    });
-  }
-
-  /**
-   * Calculate practitioner analytics on-demand
-   */
-  async calculatePractitioner(
-    practitionerId: string,
-    dateRange?: AnalyticsDateRange,
-    options?: { storeInCache?: boolean; clinicBranchId?: string },
-  ) {
-    return this.calculateOnDemand({
-      analyticsType: 'practitioner',
-      entityId: practitionerId,
-      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
-      dateRange: dateRange
-        ? {
-            start: dateRange.start.toISOString(),
-            end: dateRange.end.toISOString(),
-          }
-        : undefined,
-      options,
-    });
-  }
-
-  /**
-   * Calculate procedure analytics on-demand
-   */
-  async calculateProcedure(
-    procedureId: string,
-    dateRange?: AnalyticsDateRange,
-    options?: { storeInCache?: boolean; clinicBranchId?: string },
-  ) {
-    return this.calculateOnDemand({
-      analyticsType: 'procedure',
-      entityId: procedureId,
-      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
-      dateRange: dateRange
-        ? {
-            start: dateRange.start.toISOString(),
-            end: dateRange.end.toISOString(),
-          }
-        : undefined,
-      options,
-    });
-  }
-
-  /**
-   * Calculate revenue metrics grouped by entity on-demand
-   */
-  async calculateRevenueByEntity(
-    groupBy: EntityType,
-    dateRange?: AnalyticsDateRange,
-    filters?: AnalyticsFilters,
-    options?: { storeInCache?: boolean },
-  ) {
-    return this.calculateOnDemand({
-      analyticsType: 'revenueByEntity',
-      groupBy,
-      filters,
-      dateRange: dateRange
-        ? {
-            start: dateRange.start.toISOString(),
-            end: dateRange.end.toISOString(),
-          }
-        : undefined,
-      options,
-    });
-  }
-
-  /**
-   * Calculate cancellation metrics grouped by entity on-demand
-   */
-  async calculateCancellations(
-    groupBy: EntityType,
-    dateRange?: AnalyticsDateRange,
-    options?: { storeInCache?: boolean; clinicBranchId?: string },
-  ) {
-    return this.calculateOnDemand({
-      analyticsType: 'cancellation',
-      groupBy,
-      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
-      dateRange: dateRange
-        ? {
-            start: dateRange.start.toISOString(),
-            end: dateRange.end.toISOString(),
-          }
-        : undefined,
-      options,
-    });
-  }
-
-  /**
-   * Calculate no-show metrics grouped by entity on-demand
-   */
-  async calculateNoShows(
-    groupBy: EntityType,
-    dateRange?: AnalyticsDateRange,
-    options?: { storeInCache?: boolean; clinicBranchId?: string },
-  ) {
-    return this.calculateOnDemand({
-      analyticsType: 'noShow',
-      groupBy,
-      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
-      dateRange: dateRange
-        ? {
-            start: dateRange.start.toISOString(),
-            end: dateRange.end.toISOString(),
-          }
-        : undefined,
-      options,
-    });
-  }
-}
-
+import { Functions, getFunctions, httpsCallable } from 'firebase/functions';
+import { FirebaseApp } from 'firebase/app';
+import {
+  AnalyticsDateRange,
+  AnalyticsFilters,
+  EntityType,
+} from '../../types/analytics';
+
+/**
+ * Request data for on-demand analytics calculation
+ */
+interface CalculateAnalyticsRequest {
+  analyticsType:
+    | 'dashboard'
+    | 'practitioner'
+    | 'procedure'
+    | 'clinic'
+    | 'timeEfficiency'
+    | 'revenue'
+    | 'cancellation'
+    | 'noShow'
+    | 'productUsage'
+    | 'patient'
+    | 'revenueByEntity'
+    | 'productUsageByEntity'
+    | 'timeEfficiencyByEntity'
+    | 'patientBehaviorByEntity';
+  filters?: AnalyticsFilters;
+  dateRange?: {
+    start: string; // ISO date string
+    end: string; // ISO date string
+  };
+  entityId?: string;
+  groupBy?: EntityType;
+  options?: {
+    storeInCache?: boolean;
+    useCache?: boolean;
+    maxCacheAgeHours?: number;
+  };
+}
+
+/**
+ * Response from on-demand analytics calculation
+ */
+interface CalculateAnalyticsResponse {
+  success: boolean;
+  data: any;
+  computedAt: string;
+}
+
+/**
+ * Client-side service for calling analytics Cloud Functions
+ * 
+ * This service provides a convenient way to trigger on-demand analytics
+ * calculations via Cloud Functions, which can be faster and more efficient
+ * than calculating on the client.
+ */
+export class AnalyticsCloudService {
+  private functions: Functions;
+
+  /**
+   * Creates a new AnalyticsCloudService instance
+   *
+   * @param app - Firebase App instance
+   * @param region - Functions region (default: 'europe-west6')
+   */
+  constructor(app: FirebaseApp, region: string = 'europe-west6') {
+    this.functions = getFunctions(app, region);
+  }
+
+  /**
+   * Calls the Cloud Function to calculate analytics on-demand
+   *
+   * @param request - Analytics calculation request
+   * @returns Promise resolving to the calculated analytics data
+   */
+  async calculateOnDemand(request: CalculateAnalyticsRequest): Promise<any> {
+    const callable = httpsCallable<CalculateAnalyticsRequest, CalculateAnalyticsResponse>(
+      this.functions,
+      'calculateAnalyticsOnDemand',
+    );
+
+    const response = await callable(request);
+
+    if (!response.data.success) {
+      throw new Error('Analytics calculation failed');
+    }
+
+    return response.data.data;
+  }
+
+  /**
+   * Calculate dashboard analytics on-demand
+   */
+  async calculateDashboard(
+    filters: AnalyticsFilters,
+    dateRange: AnalyticsDateRange,
+    options?: { storeInCache?: boolean },
+  ) {
+    return this.calculateOnDemand({
+      analyticsType: 'dashboard',
+      filters,
+      dateRange: {
+        start: dateRange.start.toISOString(),
+        end: dateRange.end.toISOString(),
+      },
+      options,
+    });
+  }
+
+  /**
+   * Calculate practitioner analytics on-demand
+   */
+  async calculatePractitioner(
+    practitionerId: string,
+    dateRange?: AnalyticsDateRange,
+    options?: { storeInCache?: boolean; clinicBranchId?: string },
+  ) {
+    return this.calculateOnDemand({
+      analyticsType: 'practitioner',
+      entityId: practitionerId,
+      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
+      dateRange: dateRange
+        ? {
+            start: dateRange.start.toISOString(),
+            end: dateRange.end.toISOString(),
+          }
+        : undefined,
+      options,
+    });
+  }
+
+  /**
+   * Calculate procedure analytics on-demand
+   */
+  async calculateProcedure(
+    procedureId: string,
+    dateRange?: AnalyticsDateRange,
+    options?: { storeInCache?: boolean; clinicBranchId?: string },
+  ) {
+    return this.calculateOnDemand({
+      analyticsType: 'procedure',
+      entityId: procedureId,
+      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
+      dateRange: dateRange
+        ? {
+            start: dateRange.start.toISOString(),
+            end: dateRange.end.toISOString(),
+          }
+        : undefined,
+      options,
+    });
+  }
+
+  /**
+   * Calculate revenue metrics grouped by entity on-demand
+   */
+  async calculateRevenueByEntity(
+    groupBy: EntityType,
+    dateRange?: AnalyticsDateRange,
+    filters?: AnalyticsFilters,
+    options?: { storeInCache?: boolean },
+  ) {
+    return this.calculateOnDemand({
+      analyticsType: 'revenueByEntity',
+      groupBy,
+      filters,
+      dateRange: dateRange
+        ? {
+            start: dateRange.start.toISOString(),
+            end: dateRange.end.toISOString(),
+          }
+        : undefined,
+      options,
+    });
+  }
+
+  /**
+   * Calculate cancellation metrics grouped by entity on-demand
+   */
+  async calculateCancellations(
+    groupBy: EntityType,
+    dateRange?: AnalyticsDateRange,
+    options?: { storeInCache?: boolean; clinicBranchId?: string },
+  ) {
+    return this.calculateOnDemand({
+      analyticsType: 'cancellation',
+      groupBy,
+      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
+      dateRange: dateRange
+        ? {
+            start: dateRange.start.toISOString(),
+            end: dateRange.end.toISOString(),
+          }
+        : undefined,
+      options,
+    });
+  }
+
+  /**
+   * Calculate no-show metrics grouped by entity on-demand
+   */
+  async calculateNoShows(
+    groupBy: EntityType,
+    dateRange?: AnalyticsDateRange,
+    options?: { storeInCache?: boolean; clinicBranchId?: string },
+  ) {
+    return this.calculateOnDemand({
+      analyticsType: 'noShow',
+      groupBy,
+      filters: options?.clinicBranchId ? { clinicBranchId: options.clinicBranchId } : undefined,
+      dateRange: dateRange
+        ? {
+            start: dateRange.start.toISOString(),
+            end: dateRange.end.toISOString(),
+          }
+        : undefined,
+      options,
+    });
+  }
+}
+