@blackcode_sa/metaestetics-api 1.12.67 → 1.13.0

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

@@ -0,0 +1,137 @@
+import { Timestamp } from 'firebase/firestore';
+import {
+  PractitionerAnalytics,
+  ProcedureAnalytics,
+  TimeEfficiencyMetrics,
+  CancellationMetrics,
+  NoShowMetrics,
+  RevenueMetrics,
+  DashboardAnalytics,
+  ClinicAnalytics,
+  AnalyticsDateRange,
+} from './analytics.types';
+
+/**
+ * Period type for analytics snapshots
+ */
+export type AnalyticsPeriod = 'daily' | 'weekly' | 'monthly' | 'yearly' | 'all_time';
+
+/**
+ * Analytics document metadata
+ */
+export interface AnalyticsMetadata {
+  clinicBranchId: string;
+  period: AnalyticsPeriod;
+  periodStart: Date;
+  periodEnd: Date;
+  computedAt: Timestamp;
+  computedBy: 'cloud_function' | 'manual';
+  version: string; // Schema version for future migrations
+}
+
+/**
+ * Stored Practitioner Analytics
+ * Stored in: clinics/{clinicBranchId}/analytics/practitioners/{practitionerId}/{period}
+ */
+export interface StoredPractitionerAnalytics extends PractitionerAnalytics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Stored Procedure Analytics
+ * Stored in: clinics/{clinicBranchId}/analytics/procedures/{procedureId}/{period}
+ */
+export interface StoredProcedureAnalytics extends ProcedureAnalytics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Stored Clinic Analytics
+ * Stored in: clinics/{clinicBranchId}/analytics/clinic/{period}
+ */
+export interface StoredClinicAnalytics extends ClinicAnalytics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Stored Dashboard Analytics
+ * Stored in: clinics/{clinicBranchId}/analytics/dashboard/{period}
+ */
+export interface StoredDashboardAnalytics extends DashboardAnalytics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Stored Time Efficiency Metrics
+ * Stored in: clinics/{clinicBranchId}/analytics/time_efficiency/{period}
+ */
+export interface StoredTimeEfficiencyMetrics extends TimeEfficiencyMetrics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Stored Cancellation Metrics
+ * Stored in: clinics/{clinicBranchId}/analytics/cancellations/{entityType}/{period}
+ */
+export interface StoredCancellationMetrics extends CancellationMetrics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Stored No-Show Metrics
+ * Stored in: clinics/{clinicBranchId}/analytics/no_shows/{entityType}/{period}
+ */
+export interface StoredNoShowMetrics extends NoShowMetrics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Stored Revenue Metrics
+ * Stored in: clinics/{clinicBranchId}/analytics/revenue/{period}
+ */
+export interface StoredRevenueMetrics extends RevenueMetrics {
+  metadata: AnalyticsMetadata;
+}
+
+/**
+ * Collection names for stored analytics
+ */
+export const ANALYTICS_COLLECTION = 'analytics';
+export const PRACTITIONER_ANALYTICS_SUBCOLLECTION = 'practitioners';
+export const PROCEDURE_ANALYTICS_SUBCOLLECTION = 'procedures';
+export const CLINIC_ANALYTICS_SUBCOLLECTION = 'clinic';
+export const DASHBOARD_ANALYTICS_SUBCOLLECTION = 'dashboard';
+export const TIME_EFFICIENCY_ANALYTICS_SUBCOLLECTION = 'time_efficiency';
+export const CANCELLATION_ANALYTICS_SUBCOLLECTION = 'cancellations';
+export const NO_SHOW_ANALYTICS_SUBCOLLECTION = 'no_shows';
+export const REVENUE_ANALYTICS_SUBCOLLECTION = 'revenue';
+
+/**
+ * Options for reading stored analytics
+ */
+export interface ReadStoredAnalyticsOptions {
+  /**
+   * Whether to use cached/pre-computed data
+   * @default true
+   */
+  useCache?: boolean;
+  /**
+   * Maximum age of cached data in hours before recalculating
+   * @default 12
+   */
+  maxCacheAgeHours?: number;
+  /**
+   * Period to read
+   * @default 'all_time'
+   */
+  period?: AnalyticsPeriod;
+  /**
+   * Date range for the period (calculated if not provided)
+   */
+  dateRange?: AnalyticsDateRange;
+  /**
+   * Clinic branch ID (required for reading stored analytics)
+   */
+  clinicBranchId?: string;
+}
+

package/src/types/index.ts

@@ -40,5 +40,8 @@ export * from "./profile";
 // Reviews types
 export * from "./reviews";
 
+// Analytics types
+export * from "./analytics";
+
 // User types
 export * from "./user";

package/src/types/notifications/index.ts

@@ -21,6 +21,7 @@ export enum NotificationType {
 
   // --- Patient Engagement ---
   REVIEW_REQUEST = "reviewRequest", // Request for patient review post-appointment
+  PROCEDURE_RECOMMENDATION = "procedureRecommendation", // Doctor recommended a procedure for follow-up
 
   // --- Payment Related (Examples) ---
   PAYMENT_DUE = "paymentDue",
@@ -231,6 +232,25 @@ export interface ReviewRequestNotification extends BaseNotification {
   procedureName?: string;
 }
 
+/**
+ * Notification for when a doctor recommends a procedure for follow-up.
+ * Example: "Dr. Smith recommended [Procedure Name] for you. Suggested timeframe: in 2 weeks"
+ */
+export interface ProcedureRecommendationNotification extends BaseNotification {
+  notificationType: NotificationType.PROCEDURE_RECOMMENDATION;
+  appointmentId: string; // The appointment where recommendation was made
+  recommendationId: string; // Format: `${appointmentId}:${index}`
+  procedureId: string;
+  procedureName: string;
+  practitionerName: string;
+  clinicName: string;
+  note?: string; // Doctor's note about the recommendation
+  timeframe: {
+    value: number;
+    unit: 'day' | 'week' | 'month' | 'year';
+  };
+}
+
 /**
  * Generic notification for direct messages or announcements.
  */
@@ -261,5 +281,6 @@ export type Notification =
   | FormReminderNotification
   | FormSubmissionConfirmationNotification
   | ReviewRequestNotification
+  | ProcedureRecommendationNotification
   | GeneralMessageNotification
   | PaymentConfirmationNotification;