@blackcode_sa/metaestetics-api 1.6.11 → 1.6.13

package/dist/admin/index.d.mts

@@ -1800,6 +1800,106 @@ declare class PatientAggregationService {
     cancelUpcomingCalendarEventsForPatient(patientId: string): Promise<void>;
 }
 
+/**
+ * @class AppointmentAggregationService
+ * @description Handles aggregation tasks and side effects related to appointment lifecycle events.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the appointments collection.
+ */
+declare class AppointmentAggregationService {
+    private db;
+    private appointmentMailingService;
+    private notificationsAdmin;
+    private calendarAdminService;
+    private patientRequirementsAdminService;
+    /**
+     * Constructor for AppointmentAggregationService.
+     * @param mailgunClient - An initialized Mailgun client instance.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(mailgunClient: any, // Type as 'any' for now, to be provided by the calling Cloud Function
+    firestore?: admin.firestore.Firestore);
+    /**
+     * Handles side effects when an appointment is first created.
+     * This function would typically be called by an Firestore onCreate trigger.
+     * @param {Appointment} appointment - The newly created Appointment object.
+     * @returns {Promise<void>}
+     */
+    handleAppointmentCreate(appointment: Appointment): Promise<void>;
+    /**
+     * Handles side effects when an appointment is updated.
+     * This function would typically be called by an Firestore onUpdate trigger.
+     * @param {Appointment} before - The Appointment object before the update.
+     * @param {Appointment} after - The Appointment object after the update.
+     * @returns {Promise<void>}
+     */
+    handleAppointmentUpdate(before: Appointment, after: Appointment): Promise<void>;
+    /**
+     * Handles side effects when an appointment is deleted.
+     * @param deletedAppointment - The Appointment object that was deleted.
+     * @returns {Promise<void>}
+     */
+    handleAppointmentDelete(deletedAppointment: Appointment): Promise<void>;
+    /**
+     * Creates PRE_APPOINTMENT PatientRequirementInstance documents for a given appointment.
+     * Uses the `appointment.preProcedureRequirements` array, which should contain relevant Requirement templates.
+     * For each active PRE requirement template, it constructs a new PatientRequirementInstance document
+     * with derived instructions and batch writes them to Firestore under the patient's `patient_requirements` subcollection.
+     *
+     * @param {Appointment} appointment - The appointment for which to create pre-requirement instances.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private createPreAppointmentRequirementInstances;
+    /**
+     * Creates POST_APPOINTMENT PatientRequirementInstance documents for a given appointment.
+     * Uses the `appointment.postProcedureRequirements` array.
+     * For each active POST requirement template, it constructs a new PatientRequirementInstance document
+     * with derived instructions and batch writes them to Firestore under the patient's `patient_requirements` subcollection.
+     *
+     * @param {Appointment} appointment - The appointment for which to create post-requirement instances.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private createPostAppointmentRequirementInstances;
+    /**
+     * Updates the overallStatus of all PatientRequirementInstance documents associated with a given appointment.
+     * This is typically used when an appointment is cancelled or rescheduled, making existing requirements void.
+     *
+     * @param {Appointment} appointment - The appointment whose requirement instances need updating.
+     * @param {PatientRequirementOverallStatus} newOverallStatus - The new status to set (e.g., CANCELLED_APPOINTMENT).
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private updateRelatedPatientRequirementInstances;
+    /**
+     * Manages denormalized links between a patient and the clinic/practitioner associated with an appointment.
+     * Adds patientId to arrays on clinic and practitioner documents on appointment creation.
+     * Removes patientId on appointment cancellation (basic removal, can be enhanced).
+     *
+     * @param {Appointment} appointment - The appointment object.
+     * @param {"create" | "cancel"} action - 'create' to add links, 'cancel' to remove them.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private managePatientClinicPractitionerLinks;
+    private fetchPatientProfile;
+    /**
+     * Fetches the sensitive information for a given patient ID.
+     * @param patientId The ID of the patient to fetch sensitive information for.
+     * @returns {Promise<PatientSensitiveInfo | null>} The patient sensitive information or null if not found or an error occurs.
+     */
+    private fetchPatientSensitiveInfo;
+    /**
+     * Fetches the profile for a given practitioner ID.
+     * @param practitionerId The ID of the practitioner to fetch.
+     * @returns {Promise<Practitioner | null>} The practitioner profile or null if not found or an error occurs.
+     */
+    private fetchPractitionerProfile;
+    /**
+     * Fetches the information for a given clinic ID.
+     * @param clinicId The ID of the clinic to fetch.
+     * @returns {Promise<Clinic | null>} The clinic information or null if not found or an error occurs.
+     */
+    private fetchClinicInfo;
+}
+
 /**
  * Minimal interface for the new mailgun.js client's messages API
  * This helps avoid a direct dependency on mailgun.js in the API package if not desired,
@@ -2166,4 +2266,4 @@ interface TimeInterval {
     end: Timestamp;
 }
 
-export { type AppointmentReminderNotification, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, type BookingAvailabilityRequest, type BookingAvailabilityResponse, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, type TimeInterval, UserRole };
+export { type Appointment, AppointmentAggregationService, type AppointmentReminderNotification, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, type BookingAvailabilityRequest, type BookingAvailabilityResponse, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, type TimeInterval, UserRole };

package/dist/admin/index.d.ts

@@ -1800,6 +1800,106 @@ declare class PatientAggregationService {
     cancelUpcomingCalendarEventsForPatient(patientId: string): Promise<void>;
 }
 
+/**
+ * @class AppointmentAggregationService
+ * @description Handles aggregation tasks and side effects related to appointment lifecycle events.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the appointments collection.
+ */
+declare class AppointmentAggregationService {
+    private db;
+    private appointmentMailingService;
+    private notificationsAdmin;
+    private calendarAdminService;
+    private patientRequirementsAdminService;
+    /**
+     * Constructor for AppointmentAggregationService.
+     * @param mailgunClient - An initialized Mailgun client instance.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(mailgunClient: any, // Type as 'any' for now, to be provided by the calling Cloud Function
+    firestore?: admin.firestore.Firestore);
+    /**
+     * Handles side effects when an appointment is first created.
+     * This function would typically be called by an Firestore onCreate trigger.
+     * @param {Appointment} appointment - The newly created Appointment object.
+     * @returns {Promise<void>}
+     */
+    handleAppointmentCreate(appointment: Appointment): Promise<void>;
+    /**
+     * Handles side effects when an appointment is updated.
+     * This function would typically be called by an Firestore onUpdate trigger.
+     * @param {Appointment} before - The Appointment object before the update.
+     * @param {Appointment} after - The Appointment object after the update.
+     * @returns {Promise<void>}
+     */
+    handleAppointmentUpdate(before: Appointment, after: Appointment): Promise<void>;
+    /**
+     * Handles side effects when an appointment is deleted.
+     * @param deletedAppointment - The Appointment object that was deleted.
+     * @returns {Promise<void>}
+     */
+    handleAppointmentDelete(deletedAppointment: Appointment): Promise<void>;
+    /**
+     * Creates PRE_APPOINTMENT PatientRequirementInstance documents for a given appointment.
+     * Uses the `appointment.preProcedureRequirements` array, which should contain relevant Requirement templates.
+     * For each active PRE requirement template, it constructs a new PatientRequirementInstance document
+     * with derived instructions and batch writes them to Firestore under the patient's `patient_requirements` subcollection.
+     *
+     * @param {Appointment} appointment - The appointment for which to create pre-requirement instances.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private createPreAppointmentRequirementInstances;
+    /**
+     * Creates POST_APPOINTMENT PatientRequirementInstance documents for a given appointment.
+     * Uses the `appointment.postProcedureRequirements` array.
+     * For each active POST requirement template, it constructs a new PatientRequirementInstance document
+     * with derived instructions and batch writes them to Firestore under the patient's `patient_requirements` subcollection.
+     *
+     * @param {Appointment} appointment - The appointment for which to create post-requirement instances.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private createPostAppointmentRequirementInstances;
+    /**
+     * Updates the overallStatus of all PatientRequirementInstance documents associated with a given appointment.
+     * This is typically used when an appointment is cancelled or rescheduled, making existing requirements void.
+     *
+     * @param {Appointment} appointment - The appointment whose requirement instances need updating.
+     * @param {PatientRequirementOverallStatus} newOverallStatus - The new status to set (e.g., CANCELLED_APPOINTMENT).
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private updateRelatedPatientRequirementInstances;
+    /**
+     * Manages denormalized links between a patient and the clinic/practitioner associated with an appointment.
+     * Adds patientId to arrays on clinic and practitioner documents on appointment creation.
+     * Removes patientId on appointment cancellation (basic removal, can be enhanced).
+     *
+     * @param {Appointment} appointment - The appointment object.
+     * @param {"create" | "cancel"} action - 'create' to add links, 'cancel' to remove them.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private managePatientClinicPractitionerLinks;
+    private fetchPatientProfile;
+    /**
+     * Fetches the sensitive information for a given patient ID.
+     * @param patientId The ID of the patient to fetch sensitive information for.
+     * @returns {Promise<PatientSensitiveInfo | null>} The patient sensitive information or null if not found or an error occurs.
+     */
+    private fetchPatientSensitiveInfo;
+    /**
+     * Fetches the profile for a given practitioner ID.
+     * @param practitionerId The ID of the practitioner to fetch.
+     * @returns {Promise<Practitioner | null>} The practitioner profile or null if not found or an error occurs.
+     */
+    private fetchPractitionerProfile;
+    /**
+     * Fetches the information for a given clinic ID.
+     * @param clinicId The ID of the clinic to fetch.
+     * @returns {Promise<Clinic | null>} The clinic information or null if not found or an error occurs.
+     */
+    private fetchClinicInfo;
+}
+
 /**
  * Minimal interface for the new mailgun.js client's messages API
  * This helps avoid a direct dependency on mailgun.js in the API package if not desired,
@@ -2166,4 +2266,4 @@ interface TimeInterval {
     end: Timestamp;
 }
 
-export { type AppointmentReminderNotification, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, type BookingAvailabilityRequest, type BookingAvailabilityResponse, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, type TimeInterval, UserRole };
+export { type Appointment, AppointmentAggregationService, type AppointmentReminderNotification, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, type BookingAvailabilityRequest, type BookingAvailabilityResponse, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, type TimeInterval, UserRole };