@blackcode_sa/metaestetics-api 1.5.29 → 1.5.31

package/dist/admin/index.d.mts

@@ -1,5 +1,6 @@
 import { Timestamp } from 'firebase/firestore';
 import * as admin from 'firebase-admin';
+import * as mailgun from 'mailgun-js';
 
 /**
  * Enum for element types in documentation templates
@@ -689,6 +690,15 @@ declare enum PractitionerStatus {
     DRAFT = "draft",
     ACTIVE = "active"
 }
+/**
+ * Token status for practitioner invitations
+ */
+declare enum PractitionerTokenStatus {
+    ACTIVE = "active",
+    USED = "used",
+    EXPIRED = "expired",
+    REVOKED = "revoked"
+}
 /**
  * Interfejs za zdravstvenog radnika
  */
@@ -709,6 +719,22 @@ interface Practitioner {
     createdAt: Timestamp;
     updatedAt: Timestamp;
 }
+/**
+ * Token za pozivanje zdravstvenog radnika
+ */
+interface PractitionerToken {
+    id: string;
+    token: string;
+    practitionerId: string;
+    email: string;
+    clinicId: string;
+    status: PractitionerTokenStatus;
+    createdBy: string;
+    createdAt: Timestamp;
+    expiresAt: Timestamp;
+    usedBy?: string;
+    usedAt?: Timestamp;
+}
 
 /**
  * Interfejs za gamifikaciju
@@ -1350,4 +1376,103 @@ declare class PatientAggregationService {
     cancelUpcomingCalendarEventsForPatient(patientId: string): Promise<void>;
 }
 
-export { type AppointmentNotification, type AppointmentReminderNotification, type BaseNotification, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type PatientProfile as Patient, PatientAggregationService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, UserRole };
+/**
+ * Base mailing service class that provides common functionality for all mailing services
+ */
+declare class BaseMailingService {
+    protected db: FirebaseFirestore.Firestore;
+    protected mailgunClient: mailgun.Mailgun;
+    /**
+     * Constructor for BaseMailingService
+     * @param firestore Firestore instance provided by the caller
+     * @param mailgunClient Mailgun client instance provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: mailgun.Mailgun);
+    /**
+     * Sends an email using Mailgun
+     * @param data Email data to send, including the 'from' address
+     * @returns Promise with the sending result
+     */
+    protected sendEmail(data: mailgun.messages.SendData): Promise<mailgun.messages.SendResponse>;
+    /**
+     * 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 for the data required to send a practitioner invitation email
+ */
+interface PractitionerInviteEmailData {
+    /** The token object from the practitioner service */
+    token: {
+        id: string;
+        token: string;
+        practitionerId: string;
+        email: string;
+        clinicId: string;
+        expiresAt: admin.firestore.Timestamp;
+    };
+    /** Practitioner basic info */
+    practitioner: {
+        firstName: string;
+        lastName: string;
+    };
+    /** Clinic info */
+    clinic: {
+        name: string;
+        contactEmail: string;
+        contactName?: string;
+    };
+    /** Config options */
+    options?: {
+        registrationUrl?: string;
+        customSubject?: string;
+        fromAddress?: string;
+    };
+}
+/**
+ * Service for sending practitioner invitation emails
+ */
+declare class PractitionerInviteMailingService extends BaseMailingService {
+    private readonly DEFAULT_REGISTRATION_URL;
+    private readonly DEFAULT_SUBJECT;
+    private readonly DEFAULT_FROM_ADDRESS;
+    /**
+     * Constructor for PractitionerInviteMailingService
+     * @param firestore Firestore instance provided by the caller
+     * @param mailgunClient Mailgun client instance provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: mailgun.Mailgun);
+    /**
+     * Sends a practitioner invitation email
+     * @param data The practitioner invitation data
+     * @returns Promise resolved when email is sent
+     */
+    sendInvitationEmail(data: PractitionerInviteEmailData): Promise<mailgun.messages.SendResponse>;
+    /**
+     * Handles the practitioner token creation event from Cloud Functions
+     * Fetches necessary data using defined types and collection constants,
+     * and sends the invitation email.
+     * @param tokenData The fully typed token object including its id
+     * @param fromAddress The 'from' email address to use, obtained from config
+     * @returns Promise resolved when the email is sent
+     */
+    handleTokenCreationEvent(tokenData: PractitionerToken, fromAddress: string): Promise<void>;
+}
+
+export { type AppointmentNotification, type AppointmentReminderNotification, BaseMailingService, type BaseNotification, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type PatientProfile as Patient, PatientAggregationService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, UserRole };

package/dist/admin/index.d.ts

@@ -1,5 +1,6 @@
 import { Timestamp } from 'firebase/firestore';
 import * as admin from 'firebase-admin';
+import * as mailgun from 'mailgun-js';
 
 /**
  * Enum for element types in documentation templates
@@ -689,6 +690,15 @@ declare enum PractitionerStatus {
     DRAFT = "draft",
     ACTIVE = "active"
 }
+/**
+ * Token status for practitioner invitations
+ */
+declare enum PractitionerTokenStatus {
+    ACTIVE = "active",
+    USED = "used",
+    EXPIRED = "expired",
+    REVOKED = "revoked"
+}
 /**
  * Interfejs za zdravstvenog radnika
  */
@@ -709,6 +719,22 @@ interface Practitioner {
     createdAt: Timestamp;
     updatedAt: Timestamp;
 }
+/**
+ * Token za pozivanje zdravstvenog radnika
+ */
+interface PractitionerToken {
+    id: string;
+    token: string;
+    practitionerId: string;
+    email: string;
+    clinicId: string;
+    status: PractitionerTokenStatus;
+    createdBy: string;
+    createdAt: Timestamp;
+    expiresAt: Timestamp;
+    usedBy?: string;
+    usedAt?: Timestamp;
+}
 
 /**
  * Interfejs za gamifikaciju
@@ -1350,4 +1376,103 @@ declare class PatientAggregationService {
     cancelUpcomingCalendarEventsForPatient(patientId: string): Promise<void>;
 }
 
-export { type AppointmentNotification, type AppointmentReminderNotification, type BaseNotification, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type PatientProfile as Patient, PatientAggregationService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, UserRole };
+/**
+ * Base mailing service class that provides common functionality for all mailing services
+ */
+declare class BaseMailingService {
+    protected db: FirebaseFirestore.Firestore;
+    protected mailgunClient: mailgun.Mailgun;
+    /**
+     * Constructor for BaseMailingService
+     * @param firestore Firestore instance provided by the caller
+     * @param mailgunClient Mailgun client instance provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: mailgun.Mailgun);
+    /**
+     * Sends an email using Mailgun
+     * @param data Email data to send, including the 'from' address
+     * @returns Promise with the sending result
+     */
+    protected sendEmail(data: mailgun.messages.SendData): Promise<mailgun.messages.SendResponse>;
+    /**
+     * 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 for the data required to send a practitioner invitation email
+ */
+interface PractitionerInviteEmailData {
+    /** The token object from the practitioner service */
+    token: {
+        id: string;
+        token: string;
+        practitionerId: string;
+        email: string;
+        clinicId: string;
+        expiresAt: admin.firestore.Timestamp;
+    };
+    /** Practitioner basic info */
+    practitioner: {
+        firstName: string;
+        lastName: string;
+    };
+    /** Clinic info */
+    clinic: {
+        name: string;
+        contactEmail: string;
+        contactName?: string;
+    };
+    /** Config options */
+    options?: {
+        registrationUrl?: string;
+        customSubject?: string;
+        fromAddress?: string;
+    };
+}
+/**
+ * Service for sending practitioner invitation emails
+ */
+declare class PractitionerInviteMailingService extends BaseMailingService {
+    private readonly DEFAULT_REGISTRATION_URL;
+    private readonly DEFAULT_SUBJECT;
+    private readonly DEFAULT_FROM_ADDRESS;
+    /**
+     * Constructor for PractitionerInviteMailingService
+     * @param firestore Firestore instance provided by the caller
+     * @param mailgunClient Mailgun client instance provided by the caller
+     */
+    constructor(firestore: FirebaseFirestore.Firestore, mailgunClient: mailgun.Mailgun);
+    /**
+     * Sends a practitioner invitation email
+     * @param data The practitioner invitation data
+     * @returns Promise resolved when email is sent
+     */
+    sendInvitationEmail(data: PractitionerInviteEmailData): Promise<mailgun.messages.SendResponse>;
+    /**
+     * Handles the practitioner token creation event from Cloud Functions
+     * Fetches necessary data using defined types and collection constants,
+     * and sends the invitation email.
+     * @param tokenData The fully typed token object including its id
+     * @param fromAddress The 'from' email address to use, obtained from config
+     * @returns Promise resolved when the email is sent
+     */
+    handleTokenCreationEvent(tokenData: PractitionerToken, fromAddress: string): Promise<void>;
+}
+
+export { type AppointmentNotification, type AppointmentReminderNotification, BaseMailingService, type BaseNotification, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type DoctorInfo, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type PatientProfile as Patient, PatientAggregationService, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureSummaryInfo, UserRole };