@blackcode_sa/metaestetics-api 1.5.27 → 1.5.29

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@blackcode_sa/metaestetics-api",
   "private": false,
-  "version": "1.5.27",
+  "version": "1.5.29",
   "description": "Firebase authentication service with anonymous upgrade support",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/admin/aggregation/clinic/clinic.aggregation.service.ts

@@ -0,0 +1,642 @@
+import * as admin from "firebase-admin";
+import { ClinicInfo } from "../../../types/profile"; // Corrected path
+import { PRACTITIONERS_COLLECTION } from "../../../types/practitioner"; // Corrected path
+import { PROCEDURES_COLLECTION } from "../../../types/procedure"; // Added procedure collection
+import { CLINIC_GROUPS_COLLECTION } from "../../../types/clinic"; // Added clinic group collection
+import { ClinicLocation } from "../../../types/clinic"; // Added ClinicLocation type
+import { CALENDAR_COLLECTION } from "../../../types/calendar"; // Added calendar collection
+import { PATIENTS_COLLECTION } from "../../../types/patient"; // Added patient collection
+
+const CALENDAR_SUBCOLLECTION_ID = "calendar"; // Define the subcollection ID explicitly
+
+/**
+ * @class ClinicAggregationService
+ * @description Handles aggregation tasks related to clinic data updates.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the clinics collection.
+ */
+export class ClinicAggregationService {
+  private db: admin.firestore.Firestore;
+
+  /**
+   * Constructor for ClinicAggregationService.
+   * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+   */
+  constructor(firestore?: admin.firestore.Firestore) {
+    this.db = firestore || admin.firestore();
+  }
+
+  /**
+   * Adds clinic information to a clinic group when a new clinic is created
+   * @param clinicGroupId - ID of the parent clinic group
+   * @param clinicInfo - The clinic information to add to the group
+   * @returns {Promise<void>}
+   * @throws Will throw an error if the batch write fails
+   */
+  async addClinicToClinicGroup(
+    clinicGroupId: string,
+    clinicInfo: ClinicInfo
+  ): Promise<void> {
+    if (!clinicGroupId) {
+      console.log(
+        "[ClinicAggregationService] No Clinic Group ID provided for clinic addition. Skipping."
+      );
+      return;
+    }
+
+    const clinicId = clinicInfo.id;
+    const groupRef = this.db
+      .collection(CLINIC_GROUPS_COLLECTION)
+      .doc(clinicGroupId);
+
+    console.log(
+      `[ClinicAggregationService] Adding ClinicInfo (ID: ${clinicId}) to Clinic Group ${clinicGroupId}.`
+    );
+
+    try {
+      await groupRef.update({
+        clinicsInfo: admin.firestore.FieldValue.arrayUnion(clinicInfo),
+        clinicIds: admin.firestore.FieldValue.arrayUnion(clinicId),
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+
+      console.log(
+        `[ClinicAggregationService] Successfully added ClinicInfo (ID: ${clinicId}) to Clinic Group ${clinicGroupId}.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error adding ClinicInfo (ID: ${clinicId}) to Clinic Group ${clinicGroupId}:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Updates the ClinicInfo within the clinicsInfo array for multiple practitioners.
+   * This method is designed to be called when a clinic's core information changes.
+   * @param practitionerIds - IDs of practitioners associated with the clinic.
+   * @param clinicInfo - The updated ClinicInfo object to aggregate.
+   * @returns {Promise<void>}
+   * @throws Will throw an error if the batch write fails.
+   */
+  async updateClinicInfoInPractitioners(
+    practitionerIds: string[],
+    clinicInfo: ClinicInfo
+  ): Promise<void> {
+    if (!practitionerIds || practitionerIds.length === 0) {
+      console.log(
+        "[ClinicAggregationService] No practitioner IDs provided for clinic info update. Skipping."
+      );
+      return;
+    }
+
+    const batch = this.db.batch();
+    const clinicId = clinicInfo.id;
+
+    console.log(
+      `[ClinicAggregationService] Starting batch update of ClinicInfo (ID: ${clinicId}) in ${practitionerIds.length} practitioners.`
+    );
+
+    for (const practitionerId of practitionerIds) {
+      const practitionerRef = this.db
+        .collection(PRACTITIONERS_COLLECTION)
+        .doc(practitionerId);
+
+      // Remove old clinic info based on ID matcher
+      batch.update(practitionerRef, {
+        clinicsInfo: admin.firestore.FieldValue.arrayRemove({ id: clinicId }),
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+      // Add updated clinic info
+      batch.update(practitionerRef, {
+        clinicsInfo: admin.firestore.FieldValue.arrayUnion(clinicInfo),
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+    }
+
+    try {
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully updated ClinicInfo (ID: ${clinicId}) in ${practitionerIds.length} practitioners.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error committing batch update for ClinicInfo (ID: ${clinicId}) in practitioners:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Updates the aggregated clinicInfo field within relevant Procedure documents.
+   * @param procedureIds IDs of procedures performed at the clinic.
+   * @param clinicInfo The updated ClinicInfo object.
+   */
+  async updateClinicInfoInProcedures(
+    procedureIds: string[],
+    clinicInfo: ClinicInfo
+  ): Promise<void> {
+    if (!procedureIds || procedureIds.length === 0) {
+      console.log(
+        "[ClinicAggregationService] No procedure IDs provided for clinic info update. Skipping."
+      );
+      return;
+    }
+
+    const batch = this.db.batch();
+    const clinicId = clinicInfo.id;
+
+    console.log(
+      `[ClinicAggregationService] Starting batch update of clinicInfo field (for Clinic ID: ${clinicId}) in ${procedureIds.length} procedures.`
+    );
+
+    for (const procedureId of procedureIds) {
+      const procedureRef = this.db
+        .collection(PROCEDURES_COLLECTION)
+        .doc(procedureId);
+
+      // Update the embedded clinicInfo object directly
+      batch.update(procedureRef, {
+        clinicInfo: clinicInfo,
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+    }
+
+    try {
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully updated clinicInfo field in ${procedureIds.length} procedures for clinic ${clinicId}.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error committing batch update for clinicInfo field in procedures (Clinic ID: ${clinicId}):`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Updates the aggregated clinicsInfo array within the parent ClinicGroup document.
+   * @param clinicGroupId The ID of the parent clinic group.
+   * @param clinicInfo The updated ClinicInfo object.
+   */
+  async updateClinicInfoInClinicGroup(
+    clinicGroupId: string,
+    clinicInfo: ClinicInfo
+  ): Promise<void> {
+    if (!clinicGroupId) {
+      console.log(
+        "[ClinicAggregationService] No Clinic Group ID provided for clinic info update. Skipping."
+      );
+      return;
+    }
+
+    const batch = this.db.batch();
+    const clinicId = clinicInfo.id;
+    const groupRef = this.db
+      .collection(CLINIC_GROUPS_COLLECTION)
+      .doc(clinicGroupId);
+
+    console.log(
+      `[ClinicAggregationService] Starting update of ClinicInfo (ID: ${clinicId}) in Clinic Group ${clinicGroupId}.`
+    );
+
+    // Remove old clinic info based on ID matcher
+    batch.update(groupRef, {
+      clinicsInfo: admin.firestore.FieldValue.arrayRemove({ id: clinicId }),
+      updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+    });
+    // Add updated clinic info
+    batch.update(groupRef, {
+      clinicsInfo: admin.firestore.FieldValue.arrayUnion(clinicInfo),
+      updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+    });
+
+    try {
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully updated ClinicInfo (ID: ${clinicId}) in Clinic Group ${clinicGroupId}.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error committing update for ClinicInfo (ID: ${clinicId}) in Clinic Group ${clinicGroupId}:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Updates relevant clinic information within Patient documents.
+   * NOTE: PatientProfile stores an array of PatientClinic objects, which only contain
+   * clinicId, assignedAt, assignedBy, isActive, notes. It does *not* store aggregated
+   * ClinicInfo (like name, photo). Therefore, this method currently has limited use
+   * for general clinic info updates. It might be relevant if Clinic.isActive status changes.
+   *
+   * @param patientIds IDs of patients associated with the clinic (e.g., from PatientProfile.clinicIds).
+   * @param clinicInfo The updated ClinicInfo object (primarily for logging/context).
+   * @param clinicIsActive The current active status of the updated clinic.
+   */
+  async updateClinicInfoInPatients(
+    patientIds: string[],
+    clinicInfo: ClinicInfo,
+    clinicIsActive: boolean
+  ): Promise<void> {
+    if (!patientIds || patientIds.length === 0) {
+      console.log(
+        "[ClinicAggregationService] No patient IDs provided for clinic info update. Skipping."
+      );
+      return;
+    }
+    const clinicId = clinicInfo.id;
+    console.warn(
+      `[ClinicAggregationService] updateClinicInfoInPatients called for clinic ${clinicId}. ` +
+        `Current PatientProfile structure doesn't store full ClinicInfo per patient clinic entry. ` +
+        `Consider specific logic if Clinic active status changes or if structure evolves. ` +
+        `No direct patient updates performed by this method for info changes. Clinic isActive: ${clinicIsActive}`,
+      { patientIds, clinicInfo }
+    );
+
+    // Potential Future Logic (Example: Update isActive in PatientClinic array):
+    /*
+    const batch = this.db.batch();
+    for (const patientId of patientIds) {
+        const patientRef = this.db.collection(PATIENTS_COLLECTION).doc(patientId);
+        // This is complex: Firestore cannot directly update a specific element in an array based on a condition.
+        // You would need to read the patient doc, find the PatientClinic object with the matching clinicId,
+        // update its isActive status in memory, and then write the entire modified 'clinics' array back.
+        // This is inefficient and prone to race conditions without transactions.
+        // A better approach might be needed if this functionality is critical.
+        // For now, we just log the warning.
+    }
+    // await batch.commit();
+    */
+  }
+
+  /**
+   * Updates the eventLocation for upcoming calendar events associated with a specific clinic.
+   * Uses a collection group query to find relevant events across all potential parent collections.
+   *
+   * @param clinicId The ID of the clinic whose location might have changed.
+   * @param newLocation The new ClinicLocation object.
+   */
+  async updateClinicLocationInCalendarEvents(
+    clinicId: string,
+    newLocation: ClinicLocation
+  ): Promise<void> {
+    if (!clinicId || !newLocation) {
+      console.log(
+        "[ClinicAggregationService] Missing clinicId or newLocation for calendar update. Skipping."
+      );
+      return;
+    }
+
+    console.log(
+      `[ClinicAggregationService] Querying upcoming calendar events via collection group '${CALENDAR_SUBCOLLECTION_ID}' for clinic ${clinicId} to update location.`
+    );
+
+    const now = admin.firestore.Timestamp.now();
+    // Use a Collection Group query
+    const calendarEventsQuery = this.db
+      .collectionGroup(CALENDAR_SUBCOLLECTION_ID)
+      .where("clinicBranchId", "==", clinicId)
+      .where("eventTime.start", ">", now);
+
+    try {
+      const snapshot = await calendarEventsQuery.get();
+      if (snapshot.empty) {
+        console.log(
+          `[ClinicAggregationService] No upcoming calendar events found via collection group for clinic ${clinicId}. No location updates needed.`
+        );
+        return;
+      }
+
+      const batch = this.db.batch();
+      snapshot.docs.forEach((doc) => {
+        // doc.ref points to the document within its specific subcollection
+        // (e.g., /practitioners/{id}/calendar/{eventId})
+        console.log(
+          `[ClinicAggregationService] Updating location for calendar event ${doc.ref.path}`
+        );
+        batch.update(doc.ref, {
+          eventLocation: newLocation,
+          updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+        });
+      });
+
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully updated location in ${snapshot.size} upcoming calendar events via collection group for clinic ${clinicId}.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error updating location in calendar events via collection group for clinic ${clinicId}:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Updates clinic info in all upcoming calendar events associated with a specific clinic.
+   * @param clinicId The ID of the clinic whose info has been updated.
+   * @param clinicInfo The updated ClinicInfo object.
+   */
+  async updateClinicInfoInCalendarEvents(
+    clinicId: string,
+    clinicInfo: ClinicInfo
+  ): Promise<void> {
+    if (!clinicId || !clinicInfo) {
+      console.log(
+        "[ClinicAggregationService] Missing clinicId or clinicInfo for calendar update. Skipping."
+      );
+      return;
+    }
+
+    console.log(
+      `[ClinicAggregationService] Querying upcoming calendar events for clinic ${clinicId} to update clinic info.`
+    );
+
+    const now = admin.firestore.Timestamp.now();
+    // Use a Collection Group query
+    const calendarEventsQuery = this.db
+      .collectionGroup(CALENDAR_SUBCOLLECTION_ID)
+      .where("clinicBranchId", "==", clinicId)
+      .where("eventTime.start", ">", now);
+
+    try {
+      const snapshot = await calendarEventsQuery.get();
+      if (snapshot.empty) {
+        console.log(
+          `[ClinicAggregationService] No upcoming calendar events found for clinic ${clinicId}. No clinic info updates needed.`
+        );
+        return;
+      }
+
+      const batch = this.db.batch();
+      snapshot.docs.forEach((doc) => {
+        console.log(
+          `[ClinicAggregationService] Updating clinic info for calendar event ${doc.ref.path}`
+        );
+        batch.update(doc.ref, {
+          clinicInfo: clinicInfo,
+          updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+        });
+      });
+
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully updated clinic info in ${snapshot.size} upcoming calendar events for clinic ${clinicId}.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error updating clinic info in calendar events for clinic ${clinicId}:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Removes clinic from practitioners when a clinic is deleted.
+   * @param practitionerIds IDs of practitioners associated with the clinic.
+   * @param clinicId The ID of the deleted clinic.
+   */
+  async removeClinicFromPractitioners(
+    practitionerIds: string[],
+    clinicId: string
+  ): Promise<void> {
+    if (!practitionerIds || practitionerIds.length === 0) {
+      console.log(
+        "[ClinicAggregationService] No practitioner IDs provided for clinic removal. Skipping."
+      );
+      return;
+    }
+
+    const batch = this.db.batch();
+
+    console.log(
+      `[ClinicAggregationService] Starting batch removal of Clinic (ID: ${clinicId}) from ${practitionerIds.length} practitioners.`
+    );
+
+    for (const practitionerId of practitionerIds) {
+      const practitionerRef = this.db
+        .collection(PRACTITIONERS_COLLECTION)
+        .doc(practitionerId);
+
+      // Remove clinic ID from clinicIds array
+      batch.update(practitionerRef, {
+        clinicIds: admin.firestore.FieldValue.arrayRemove(clinicId),
+        // Remove all clinic info objects where id matches the clinic ID
+        clinicsInfo: admin.firestore.FieldValue.arrayRemove({ id: clinicId }),
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+    }
+
+    try {
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully removed Clinic (ID: ${clinicId}) from ${practitionerIds.length} practitioners.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error committing batch removal for Clinic (ID: ${clinicId}) from practitioners:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Inactivates all procedures associated with a deleted clinic
+   * @param procedureIds IDs of procedures associated with the clinic
+   */
+  async inactivateProceduresForClinic(procedureIds: string[]): Promise<void> {
+    if (!procedureIds || procedureIds.length === 0) {
+      console.log(
+        "[ClinicAggregationService] No procedure IDs provided for inactivation. Skipping."
+      );
+      return;
+    }
+
+    const batch = this.db.batch();
+
+    console.log(
+      `[ClinicAggregationService] Starting inactivation of ${procedureIds.length} procedures.`
+    );
+
+    for (const procedureId of procedureIds) {
+      const procedureRef = this.db
+        .collection(PROCEDURES_COLLECTION)
+        .doc(procedureId);
+
+      batch.update(procedureRef, {
+        isActive: false,
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+    }
+
+    try {
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully inactivated ${procedureIds.length} procedures.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error committing batch inactivation of procedures:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Removes clinic from clinic group when a clinic is deleted
+   * @param clinicGroupId ID of the parent clinic group
+   * @param clinicId ID of the deleted clinic
+   */
+  async removeClinicFromClinicGroup(
+    clinicGroupId: string,
+    clinicId: string
+  ): Promise<void> {
+    if (!clinicGroupId) {
+      console.log(
+        "[ClinicAggregationService] No Clinic Group ID provided for clinic removal. Skipping."
+      );
+      return;
+    }
+
+    const groupRef = this.db
+      .collection(CLINIC_GROUPS_COLLECTION)
+      .doc(clinicGroupId);
+
+    console.log(
+      `[ClinicAggregationService] Removing Clinic (ID: ${clinicId}) from Clinic Group ${clinicGroupId}.`
+    );
+
+    try {
+      await groupRef.update({
+        clinicIds: admin.firestore.FieldValue.arrayRemove(clinicId),
+        // Remove all clinic info objects where id matches the clinic ID
+        clinicsInfo: admin.firestore.FieldValue.arrayRemove({ id: clinicId }),
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+
+      console.log(
+        `[ClinicAggregationService] Successfully removed Clinic (ID: ${clinicId}) from Clinic Group ${clinicGroupId}.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error removing Clinic (ID: ${clinicId}) from Clinic Group ${clinicGroupId}:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Removes clinic from patients when a clinic is deleted
+   * @param patientIds IDs of patients associated with the clinic
+   * @param clinicId ID of the deleted clinic
+   */
+  async removeClinicFromPatients(
+    patientIds: string[],
+    clinicId: string
+  ): Promise<void> {
+    if (!patientIds || patientIds.length === 0) {
+      console.log(
+        "[ClinicAggregationService] No patient IDs provided for clinic removal. Skipping."
+      );
+      return;
+    }
+
+    const batch = this.db.batch();
+
+    console.log(
+      `[ClinicAggregationService] Starting batch removal of Clinic (ID: ${clinicId}) from ${patientIds.length} patients.`
+    );
+
+    for (const patientId of patientIds) {
+      const patientRef = this.db.collection(PATIENTS_COLLECTION).doc(patientId);
+
+      // Remove clinic ID from clinicIds array
+      batch.update(patientRef, {
+        clinicIds: admin.firestore.FieldValue.arrayRemove(clinicId),
+        updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+      });
+    }
+
+    try {
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully removed Clinic (ID: ${clinicId}) from ${patientIds.length} patients.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error committing batch removal for Clinic (ID: ${clinicId}) from patients:`,
+        error
+      );
+      throw error;
+    }
+  }
+
+  /**
+   * Cancels all upcoming calendar events associated with a deleted clinic
+   * @param clinicId ID of the deleted clinic
+   */
+  async cancelUpcomingCalendarEventsForClinic(clinicId: string): Promise<void> {
+    if (!clinicId) {
+      console.log(
+        "[ClinicAggregationService] No clinic ID provided for canceling calendar events. Skipping."
+      );
+      return;
+    }
+
+    console.log(
+      `[ClinicAggregationService] Querying upcoming calendar events for clinic ${clinicId} to cancel.`
+    );
+
+    const now = admin.firestore.Timestamp.now();
+    // Use a Collection Group query
+    const calendarEventsQuery = this.db
+      .collectionGroup(CALENDAR_SUBCOLLECTION_ID)
+      .where("clinicBranchId", "==", clinicId)
+      .where("eventTime.start", ">", now);
+
+    try {
+      const snapshot = await calendarEventsQuery.get();
+      if (snapshot.empty) {
+        console.log(
+          `[ClinicAggregationService] No upcoming calendar events found for clinic ${clinicId}. No events to cancel.`
+        );
+        return;
+      }
+
+      const batch = this.db.batch();
+      snapshot.docs.forEach((doc) => {
+        console.log(
+          `[ClinicAggregationService] Canceling calendar event ${doc.ref.path}`
+        );
+        batch.update(doc.ref, {
+          status: "CANCELED",
+          cancelReason: "Clinic deleted",
+          updatedAt: admin.firestore.FieldValue.serverTimestamp(),
+        });
+      });
+
+      await batch.commit();
+      console.log(
+        `[ClinicAggregationService] Successfully canceled ${snapshot.size} upcoming calendar events for clinic ${clinicId}.`
+      );
+    } catch (error) {
+      console.error(
+        `[ClinicAggregationService] Error canceling calendar events for clinic ${clinicId}:`,
+        error
+      );
+      throw error;
+    }
+  }
+}