@blackcode_sa/metaestetics-api 1.7.32 → 1.7.34

package/dist/admin/index.d.ts

@@ -1035,6 +1035,70 @@ declare enum ClinicTag {
     HOLIDAY_HOURS = "holiday_hours"
 }
 
+/**
+ * Enum for practitioner invite status
+ */
+declare enum PractitionerInviteStatus {
+    PENDING = "pending",
+    ACCEPTED = "accepted",
+    REJECTED = "rejected",
+    CANCELLED = "cancelled"
+}
+/**
+ * Interface for proposed working hours in practitioner invite
+ */
+interface ProposedWorkingHours {
+    monday: {
+        start: string;
+        end: string;
+    } | null;
+    tuesday: {
+        start: string;
+        end: string;
+    } | null;
+    wednesday: {
+        start: string;
+        end: string;
+    } | null;
+    thursday: {
+        start: string;
+        end: string;
+    } | null;
+    friday: {
+        start: string;
+        end: string;
+    } | null;
+    saturday: {
+        start: string;
+        end: string;
+    } | null;
+    sunday: {
+        start: string;
+        end: string;
+    } | null;
+}
+/**
+ * Main interface for practitioner invite
+ */
+interface PractitionerInvite {
+    id: string;
+    practitionerId: string;
+    clinicId: string;
+    practitionerInfo: PractitionerProfileInfo;
+    clinicInfo: ClinicInfo;
+    proposedWorkingHours: ProposedWorkingHours;
+    status: PractitionerInviteStatus;
+    invitedBy: string;
+    message?: string | null;
+    rejectionReason?: string | null;
+    cancelReason?: string | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    acceptedAt?: Timestamp | null;
+    rejectedAt?: Timestamp | null;
+    cancelledAt?: Timestamp | null;
+}
+
 /**
  * Interface for clinic contact information
  */
@@ -1919,6 +1983,335 @@ declare class PractitionerAggregationService {
     inactivateProceduresForPractitioner(procedureIds: string[]): Promise<void>;
 }
 
+/**
+ * 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,
+ * or provides clearer typing if it is.
+ */
+interface NewMailgunMessagesAPI$2 {
+    create(domain: string, data: any): Promise<any>;
+}
+interface NewMailgunClient$2 {
+    messages: NewMailgunMessagesAPI$2;
+}
+/**
+ * Base mailing service class that provides common functionality for all mailing services
+ * This version is updated to expect a mailgun.js v10+ client.
+ */
+declare class BaseMailingService {
+    protected db: FirebaseFirestore.Firestore;
+    protected mailgunClient: NewMailgunClient$2;
+    /**
+     * Constructor for BaseMailingService
+     * @param firestore Firestore instance provided by the caller
+     * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$2);
+    /**
+     * Sends an email using the new Mailgun client API.
+     * @param domain The Mailgun domain to send from (e.g., mg.metaesthetics.net)
+     * @param data Email data to send, compatible with mailgun.js messages.create API
+     * @returns Promise with the sending result
+     */
+    protected sendEmail(domain: string, // The new API requires the domain as the first argument to messages.create
+    data: any): Promise<any>;
+    /**
+     * Logs email sending attempt to Firestore for tracking
+     * @param emailData Email data that was sent
+     * @param success Whether the email was sent successfully
+     * @param error Error object if the email failed to send
+     */
+    protected logEmailAttempt(emailData: {
+        to: string;
+        subject: string;
+        templateName?: string;
+    }, success: boolean, error?: any): Promise<void>;
+    /**
+     * Renders a simple HTML email template with variables
+     * @param template HTML template string
+     * @param variables Key-value pairs to replace in the template
+     * @returns Rendered HTML string
+     */
+    protected renderTemplate(template: string, variables: Record<string, string>): string;
+}
+
+interface NewMailgunMessagesAPI$1 {
+    create(domain: string, data: any): Promise<any>;
+}
+interface NewMailgunClient$1 {
+    messages: NewMailgunMessagesAPI$1;
+}
+/**
+ * Interface for sending practitioner invitation email data
+ */
+interface ExistingPractitionerInviteEmailData {
+    /** The practitioner invite object */
+    invite: PractitionerInvite;
+    /** Practitioner details */
+    practitioner: {
+        firstName: string;
+        lastName: string;
+        email: string;
+        specialties?: string[];
+        profileImageUrl?: string | null;
+    };
+    /** Clinic details */
+    clinic: {
+        name: string;
+        address: string;
+        contactEmail: string;
+        contactPhone?: string;
+    };
+    /** URLs for accept/reject actions */
+    urls: {
+        acceptUrl: string;
+        rejectUrl: string;
+    };
+    /** Configuration options */
+    options?: {
+        customSubject?: string;
+        fromAddress?: string;
+        mailgunDomain?: string;
+    };
+}
+/**
+ * Interface for clinic admin notification email data
+ */
+interface ClinicAdminNotificationData {
+    /** The practitioner invite object */
+    invite: PractitionerInvite;
+    /** Practitioner details */
+    practitioner: {
+        firstName: string;
+        lastName: string;
+        specialties?: string[];
+        profileImageUrl?: string | null;
+        experienceYears?: number;
+    };
+    /** Clinic details */
+    clinic: {
+        name: string;
+        adminName?: string;
+        adminEmail: string;
+    };
+    /** Additional context */
+    context: {
+        invitationDate: string;
+        responseDate: string;
+        rejectionReason?: string;
+    };
+    /** URLs for dashboard access */
+    urls: {
+        clinicDashboardUrl: string;
+        practitionerProfileUrl?: string;
+        findPractitionersUrl?: string;
+    };
+    /** Configuration options */
+    options?: {
+        customSubject?: string;
+        fromAddress?: string;
+        mailgunDomain?: string;
+    };
+}
+/**
+ * Service for sending existing practitioner invitation emails
+ * This service handles the email flow for inviting active practitioners to join clinics
+ */
+declare class ExistingPractitionerInviteMailingService extends BaseMailingService {
+    private readonly DEFAULT_MAILGUN_DOMAIN;
+    private readonly DEFAULT_FROM_ADDRESS;
+    /**
+     * Constructor for ExistingPractitionerInviteMailingService
+     * @param firestore Firestore instance provided by the caller
+     * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$1);
+    /**
+     * Sends an invitation email to an existing practitioner
+     * @param data The invitation email data
+     * @returns Promise resolved when email is sent
+     */
+    sendPractitionerInvitationEmail(data: ExistingPractitionerInviteEmailData): Promise<any>;
+    /**
+     * Sends a notification email to clinic admin when practitioner accepts invitation
+     * @param data The notification email data
+     * @returns Promise resolved when email is sent
+     */
+    sendAcceptedNotificationEmail(data: ClinicAdminNotificationData): Promise<any>;
+    /**
+     * Sends a notification email to clinic admin when practitioner rejects invitation
+     * @param data The notification email data
+     * @returns Promise resolved when email is sent
+     */
+    sendRejectedNotificationEmail(data: ClinicAdminNotificationData): Promise<any>;
+    /**
+     * Handles the practitioner invite creation event
+     * Fetches necessary data and sends the invitation email to the practitioner
+     * @param invite The practitioner invite object
+     * @param mailgunConfig Mailgun configuration
+     * @returns Promise resolved when the email is sent
+     */
+    handleInviteCreationEvent(invite: PractitionerInvite, mailgunConfig: {
+        fromAddress: string;
+        domain: string;
+        acceptUrl: string;
+        rejectUrl: string;
+    }): Promise<void>;
+    /**
+     * Formats working hours for display in emails
+     * @param workingHours The working hours object
+     * @returns Formatted string representation
+     */
+    private formatWorkingHours;
+    /**
+     * Formats clinic address for display
+     * @param location The clinic location object
+     * @returns Formatted address string
+     */
+    private formatClinicAddress;
+    /**
+     * Fetches a practitioner by ID
+     * @param practitionerId The practitioner ID
+     * @returns The practitioner or null if not found
+     */
+    private fetchPractitionerById;
+    /**
+     * Fetches a clinic by ID
+     * @param clinicId The clinic ID
+     * @returns The clinic or null if not found
+     */
+    private fetchClinicById;
+}
+
+/**
+ * @class PractitionerInviteAggregationService
+ * @description Handles aggregation tasks and side effects related to practitioner invite lifecycle events.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the practitioner-invites collection.
+ */
+declare class PractitionerInviteAggregationService {
+    private db;
+    private mailingService?;
+    /**
+     * Constructor for PractitionerInviteAggregationService.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     * @param mailingService Optional mailing service for sending emails
+     */
+    constructor(firestore?: admin.firestore.Firestore, mailingService?: ExistingPractitionerInviteMailingService);
+    /**
+     * Handles side effects when a practitioner invite is first created.
+     * This function would typically be called by a Firestore onCreate trigger.
+     * @param {PractitionerInvite} invite - The newly created PractitionerInvite object.
+     * @param {object} emailConfig - Optional email configuration for sending invite emails
+     * @returns {Promise<void>}
+     */
+    handleInviteCreate(invite: PractitionerInvite, emailConfig?: {
+        fromAddress: string;
+        domain: string;
+        acceptUrl: string;
+        rejectUrl: string;
+    }): Promise<void>;
+    /**
+     * Handles side effects when a practitioner invite is updated.
+     * This function would typically be called by a Firestore onUpdate trigger.
+     * @param {PractitionerInvite} before - The PractitionerInvite object before the update.
+     * @param {PractitionerInvite} after - The PractitionerInvite object after the update.
+     * @param {object} emailConfig - Optional email configuration for sending notification emails
+     * @returns {Promise<void>}
+     */
+    handleInviteUpdate(before: PractitionerInvite, after: PractitionerInvite, emailConfig?: {
+        fromAddress: string;
+        domain: string;
+        clinicDashboardUrl: string;
+        practitionerProfileUrl?: string;
+        findPractitionersUrl?: string;
+    }): Promise<void>;
+    /**
+     * Handles side effects when a practitioner invite is deleted.
+     * @param deletedInvite - The PractitionerInvite object that was deleted.
+     * @returns {Promise<void>}
+     */
+    handleInviteDelete(deletedInvite: PractitionerInvite): Promise<void>;
+    /**
+     * Handles the business logic when a practitioner accepts an invite.
+     * This includes adding the practitioner to the clinic and the clinic to the practitioner.
+     * @param {PractitionerInvite} invite - The accepted invite
+     * @param {object} emailConfig - Optional email configuration for sending notification emails
+     * @returns {Promise<void>}
+     */
+    private handleInviteAccepted;
+    /**
+     * Handles the business logic when a practitioner rejects an invite.
+     * @param {PractitionerInvite} invite - The rejected invite
+     * @param {object} emailConfig - Optional email configuration for sending notification emails
+     * @returns {Promise<void>}
+     */
+    private handleInviteRejected;
+    /**
+     * Handles the business logic when an invite is cancelled by admin.
+     * @param {PractitionerInvite} invite - The cancelled invite
+     * @returns {Promise<void>}
+     */
+    private handleInviteCancelled;
+    /**
+     * Adds practitioner information to a clinic when an invite is accepted.
+     * @param clinicId - ID of the clinic to update
+     * @param doctorInfo - Doctor information to add to the clinic
+     * @returns {Promise<void>}
+     */
+    private addPractitionerToClinic;
+    /**
+     * Updates practitioner information in a clinic.
+     * @param clinicId - ID of the clinic to update
+     * @param doctorInfo - Updated doctor information
+     * @returns {Promise<void>}
+     */
+    private updatePractitionerInfoInClinic;
+    /**
+     * Adds a clinic to a practitioner's profile with working hours from the invite.
+     * @param {string} practitionerId - The practitioner ID
+     * @param {ClinicInfo} clinicInfo - The clinic information
+     * @param {PractitionerInvite} invite - The accepted invite containing working hours
+     * @returns {Promise<void>}
+     */
+    private addClinicToPractitioner;
+    /**
+     * Updates the working hours for an existing practitioner-clinic relationship.
+     * @param {string} practitionerId - The practitioner ID
+     * @param {PractitionerInvite} invite - The accepted invite containing new working hours
+     * @returns {Promise<void>}
+     */
+    private updatePractitionerWorkingHours;
+    /**
+     * Fetches a practitioner by ID.
+     * @param practitionerId The practitioner ID.
+     * @returns {Promise<Practitioner | null>} The practitioner or null if not found.
+     */
+    private fetchPractitionerById;
+    /**
+     * Fetches a clinic by ID.
+     * @param clinicId The clinic ID.
+     * @returns {Promise<Clinic | null>} The clinic or null if not found.
+     */
+    private fetchClinicById;
+    /**
+     * Sends acceptance notification email to clinic admin
+     * @param invite The accepted invite
+     * @param practitioner The practitioner who accepted
+     * @param clinic The clinic that sent the invite
+     * @param emailConfig Email configuration
+     */
+    private sendAcceptanceNotificationEmail;
+    /**
+     * Sends rejection notification email to clinic admin
+     * @param invite The rejected invite
+     * @param practitioner The practitioner who rejected
+     * @param clinic The clinic that sent the invite
+     * @param emailConfig Email configuration
+     */
+    private sendRejectionNotificationEmail;
+}
+
 /**
  * @class ProcedureAggregationService
  * @description Handles aggregation tasks related to procedure data updates/deletions.
@@ -2249,58 +2642,6 @@ declare class ReviewsAggregationService {
     calculateEntityReviewInfo(entityId: string, entityType: "clinic" | "practitioner" | "procedure"): Promise<ClinicReviewInfo | PractitionerReviewInfo | ProcedureReviewInfo>;
 }
 
-/**
- * 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,
- * or provides clearer typing if it is.
- */
-interface NewMailgunMessagesAPI$1 {
-    create(domain: string, data: any): Promise<any>;
-}
-interface NewMailgunClient$1 {
-    messages: NewMailgunMessagesAPI$1;
-}
-/**
- * Base mailing service class that provides common functionality for all mailing services
- * This version is updated to expect a mailgun.js v10+ client.
- */
-declare class BaseMailingService {
-    protected db: FirebaseFirestore.Firestore;
-    protected mailgunClient: NewMailgunClient$1;
-    /**
-     * Constructor for BaseMailingService
-     * @param firestore Firestore instance provided by the caller
-     * @param mailgunClient Mailgun client instance (mailgun.js v10+) provided by the caller
-     */
-    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: NewMailgunClient$1);
-    /**
-     * Sends an email using the new Mailgun client API.
-     * @param domain The Mailgun domain to send from (e.g., mg.metaesthetics.net)
-     * @param data Email data to send, compatible with mailgun.js messages.create API
-     * @returns Promise with the sending result
-     */
-    protected sendEmail(domain: string, // The new API requires the domain as the first argument to messages.create
-    data: any): Promise<any>;
-    /**
-     * Logs email sending attempt to Firestore for tracking
-     * @param emailData Email data that was sent
-     * @param success Whether the email was sent successfully
-     * @param error Error object if the email failed to send
-     */
-    protected logEmailAttempt(emailData: {
-        to: string;
-        subject: string;
-        templateName?: string;
-    }, success: boolean, error?: any): Promise<void>;
-    /**
-     * Renders a simple HTML email template with variables
-     * @param template HTML template string
-     * @param variables Key-value pairs to replace in the template
-     * @returns Rendered HTML string
-     */
-    protected renderTemplate(template: string, variables: Record<string, string>): string;
-}
-
 interface NewMailgunMessagesAPI {
     create(domain: string, data: any): Promise<any>;
 }
@@ -2887,7 +3228,7 @@ interface ReviewAddedEmailData extends AppointmentEmailDataBase {
  */
 declare class AppointmentMailingService extends BaseMailingService {
     private readonly DEFAULT_MAILGUN_DOMAIN;
-    constructor(firestore: admin.firestore.Firestore, mailgunClient: NewMailgunClient$1);
+    constructor(firestore: admin.firestore.Firestore, mailgunClient: NewMailgunClient$2);
     sendAppointmentConfirmedEmail(data: AppointmentConfirmationEmailData): Promise<any>;
     sendAppointmentRequestedEmailToClinic(data: AppointmentRequestedEmailData): Promise<any>;
     sendAppointmentCancelledEmail(data: AppointmentCancellationEmailData): Promise<any>;
@@ -2904,4 +3245,4 @@ declare class AppointmentMailingService extends BaseMailingService {
  */
 declare function freeConsultationInfrastructure(db?: admin.firestore.Firestore): Promise<boolean>;
 
-export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole, freeConsultationInfrastructure };
+export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, type ClinicAdminNotificationData, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type ExistingPractitionerInviteEmailData, ExistingPractitionerInviteMailingService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PractitionerInvite, PractitionerInviteAggregationService, PractitionerInviteMailingService, PractitionerInviteStatus, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole, freeConsultationInfrastructure };