@blackcode_sa/metaestetics-api 1.6.4 → 1.6.5

package/dist/admin/index.d.mts

@@ -171,6 +171,17 @@ interface DocumentTemplate {
     version: number;
     isActive: boolean;
 }
+/**
+ * Enum for filled document status
+ */
+declare enum FilledDocumentStatus {
+    DRAFT = "draft",
+    SKIPPED = "skipped",
+    PENDING = "pending",
+    COMPLETED = "completed",// When doctor or patient completes the form
+    SIGNED = "signed",// Only used for user forms
+    REJECTED = "rejected"
+}
 
 /**
  * Nivoi sertifikacije medicinskog osoblja, poređani od najnižeg do najvišeg
@@ -511,7 +522,9 @@ interface Product {
     id?: string;
     name: string;
     brandId: string;
+    brandName: string;
     technologyId: string;
+    technologyName: string;
     createdAt: Date;
     updatedAt: Date;
     isActive: boolean;
@@ -549,6 +562,8 @@ interface Procedure {
     id: string;
     /** Name of the procedure */
     name: string;
+    /** Photos of the procedure */
+    photos?: string[];
     /** Detailed description of the procedure */
     description: string;
     /** Family of procedures this belongs to (aesthetics/surgery) */
@@ -573,6 +588,8 @@ interface Procedure {
     blockingConditions: BlockingCondition[];
     /** Treatment benefits of this procedure */
     treatmentBenefits: TreatmentBenefit[];
+    /** Contraindications of this procedure */
+    contraindications: Contraindication[];
     /** Pre-procedure requirements */
     preRequirements: Requirement[];
     /** Post-procedure requirements */
@@ -1722,6 +1739,186 @@ declare class PractitionerInviteMailingService extends BaseMailingService {
     }): Promise<void>;
 }
 
+/**
+ * Enum defining the possible statuses of an appointment.
+ */
+declare enum AppointmentStatus {
+    PENDING = "pending",// Initial state after booking, before confirmation (if applicable)
+    CONFIRMED = "confirmed",// Confirmed by clinic/practitioner
+    CHECKED_IN = "checked_in",// Patient has arrived
+    IN_PROGRESS = "in_progress",// Procedure has started
+    COMPLETED = "completed",// Procedure finished successfully
+    CANCELED_PATIENT = "canceled_patient",// Canceled by the patient
+    CANCELED_PATIENT_RESCHEDULED = "canceled_patient_rescheduled",// Canceled by the patient and rescheduled by the clinic
+    CANCELED_CLINIC = "canceled_clinic",// Canceled by the clinic/practitioner
+    NO_SHOW = "no_show",// Patient did not attend
+    RESCHEDULED_BY_CLINIC = "rescheduled_by_clinic"
+}
+/**
+ * Enum defining the payment status of an appointment.
+ */
+declare enum PaymentStatus {
+    UNPAID = "unpaid",
+    PAID = "paid",
+    PARTIALLY_PAID = "partially_paid",
+    REFUNDED = "refunded",
+    NOT_APPLICABLE = "not_applicable"
+}
+/**
+ * Enum for different types of media that can be attached to an appointment.
+ */
+declare enum MediaType {
+    BEFORE_PHOTO = "before_photo",
+    AFTER_PHOTO = "after_photo",
+    CONSENT_SCAN = "consent_scan",
+    OTHER_DOCUMENT = "other_document"
+}
+/**
+ * Interface to describe a media file linked to an appointment.
+ */
+interface AppointmentMediaItem {
+    id: string;
+    type: MediaType;
+    url: string;
+    fileName?: string;
+    uploadedAt: Timestamp;
+    uploadedBy: string;
+    description?: string;
+}
+/**
+ * Interface for procedure-specific information
+ */
+interface ProcedureExtendedInfo {
+    id: string;
+    name: string;
+    description: string;
+    cost: number;
+    duration: number;
+    procedureFamily: ProcedureFamily;
+    procedureCategoryId: string;
+    procedureCategoryName: string;
+    procedureSubCategoryId: string;
+    procedureSubCategoryName: string;
+    procedureTechnologyId: string;
+    procedureTechnologyName: string;
+    procedureProductBrandId: string;
+    procedureProductBrandName: string;
+    procedureProductId: string;
+    procedureProductName: string;
+}
+/**
+ * Interface to describe a filled form linked to an appointment.
+ */
+interface LinkedFormInfo {
+    formId: string;
+    templateId: string;
+    templateVersion: number;
+    title: string;
+    isUserForm: boolean;
+    status: FilledDocumentStatus;
+    path: string;
+    submittedAt?: Timestamp;
+    completedAt?: Timestamp;
+}
+/**
+ * Interface for summarized patient review information linked to an appointment.
+ */
+interface PatientReviewInfo {
+    reviewId: string;
+    rating: number;
+    comment?: string;
+    reviewedAt: Timestamp;
+}
+/**
+ * Represents a booked appointment, aggregating key information and relevant procedure rules.
+ */
+interface Appointment {
+    /** Unique identifier for the appointment */
+    id: string;
+    /** Reference to the associated CalendarEvent */
+    calendarEventId: string;
+    /** ID of the clinic branch */
+    clinicBranchId: string;
+    /** Aggregated clinic information (snapshot) */
+    clinicInfo: ClinicInfo;
+    /** ID of the practitioner */
+    practitionerId: string;
+    /** Aggregated practitioner information (snapshot) */
+    practitionerInfo: PractitionerProfileInfo;
+    /** ID of the patient */
+    patientId: string;
+    /** Aggregated patient information (snapshot) */
+    patientInfo: PatientProfileInfo;
+    /** ID of the procedure */
+    procedureId: string;
+    /** Aggregated procedure information including product/brand (snapshot) */
+    procedureInfo: ProcedureSummaryInfo;
+    /** Extended procedure information */
+    procedureExtendedInfo: ProcedureExtendedInfo;
+    /** Status of the appointment */
+    status: AppointmentStatus;
+    /** Timestamps */
+    bookingTime: Timestamp;
+    confirmationTime?: Timestamp | null;
+    cancellationTime?: Timestamp | null;
+    rescheduleTime?: Timestamp | null;
+    appointmentStartTime: Timestamp;
+    appointmentEndTime: Timestamp;
+    procedureActualStartTime?: Timestamp | null;
+    actualDurationMinutes?: number;
+    /** Cancellation Details */
+    cancellationReason?: string | null;
+    canceledBy?: "patient" | "clinic" | "practitioner" | "system";
+    /** Notes */
+    internalNotes?: string | null;
+    patientNotes?: string | null;
+    /** Payment Details */
+    cost: number;
+    currency: Currency;
+    paymentStatus: PaymentStatus;
+    paymentTransactionId?: string | null;
+    /** Procedure-related conditions and requirements */
+    blockingConditions: BlockingCondition[];
+    contraindications: Contraindication[];
+    preProcedureRequirements: Requirement[];
+    postProcedureRequirements: Requirement[];
+    /** Tracking information for requirements completion */
+    completedPreRequirements?: string[];
+    completedPostRequirements?: string[];
+    /** NEW: Linked forms (consent, procedure-specific forms, etc.) */
+    linkedFormIds?: string[];
+    linkedForms?: LinkedFormInfo[];
+    pendingUserFormsIds?: string[];
+    /** NEW: Media items (before/after photos, scanned documents, etc.) */
+    media?: AppointmentMediaItem[];
+    /** NEW: Information about the patient's review for this appointment */
+    reviewInfo?: PatientReviewInfo | null;
+    /** NEW: Details about the finalization of the appointment by the practitioner */
+    finalizedDetails?: {
+        by: string;
+        at: Timestamp;
+        notes?: string;
+    };
+    /** Timestamps for record creation and updates */
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    /** Recurring appointment information */
+    isRecurring?: boolean;
+    recurringAppointmentId?: string | null;
+    /** NEW: Flag for soft deletion or archiving */
+    isArchived?: boolean;
+}
+
+/**
+ * Interface for the data required by orchestrateAppointmentCreation
+ */
+interface OrchestrateAppointmentCreationData {
+    patientId: string;
+    procedureId: string;
+    appointmentStartTime: admin.firestore.Timestamp;
+    appointmentEndTime: admin.firestore.Timestamp;
+    patientNotes?: string | null;
+}
 /**
  * Admin service for handling booking-related operations.
  * This is the cloud-based implementation that will be used in Cloud Functions.
@@ -1776,6 +1973,20 @@ declare class BookingAdmin {
      * @returns Promise resolving to an array of calendar events
      */
     private getPractitionerCalendarEvents;
+    /**
+     * Orchestrates the creation of a new appointment, including data aggregation.
+     * This method is intended to be called from a trusted backend environment (e.g., an Express route handler in a Cloud Function).
+     *
+     * @param data - Data required to create the appointment.
+     * @param authenticatedUserId - The ID of the user making the request (for auditing, and usually is the patientId).
+     * @returns Promise resolving to an object indicating success, and appointmentId or an error message.
+     */
+    orchestrateAppointmentCreation(data: OrchestrateAppointmentCreationData, authenticatedUserId: string): Promise<{
+        success: boolean;
+        appointmentId?: string;
+        appointmentData?: Appointment;
+        error?: string;
+    }>;
 }
 
 /**

package/dist/admin/index.d.ts

@@ -171,6 +171,17 @@ interface DocumentTemplate {
     version: number;
     isActive: boolean;
 }
+/**
+ * Enum for filled document status
+ */
+declare enum FilledDocumentStatus {
+    DRAFT = "draft",
+    SKIPPED = "skipped",
+    PENDING = "pending",
+    COMPLETED = "completed",// When doctor or patient completes the form
+    SIGNED = "signed",// Only used for user forms
+    REJECTED = "rejected"
+}
 
 /**
  * Nivoi sertifikacije medicinskog osoblja, poređani od najnižeg do najvišeg
@@ -511,7 +522,9 @@ interface Product {
     id?: string;
     name: string;
     brandId: string;
+    brandName: string;
     technologyId: string;
+    technologyName: string;
     createdAt: Date;
     updatedAt: Date;
     isActive: boolean;
@@ -549,6 +562,8 @@ interface Procedure {
     id: string;
     /** Name of the procedure */
     name: string;
+    /** Photos of the procedure */
+    photos?: string[];
     /** Detailed description of the procedure */
     description: string;
     /** Family of procedures this belongs to (aesthetics/surgery) */
@@ -573,6 +588,8 @@ interface Procedure {
     blockingConditions: BlockingCondition[];
     /** Treatment benefits of this procedure */
     treatmentBenefits: TreatmentBenefit[];
+    /** Contraindications of this procedure */
+    contraindications: Contraindication[];
     /** Pre-procedure requirements */
     preRequirements: Requirement[];
     /** Post-procedure requirements */
@@ -1722,6 +1739,186 @@ declare class PractitionerInviteMailingService extends BaseMailingService {
     }): Promise<void>;
 }
 
+/**
+ * Enum defining the possible statuses of an appointment.
+ */
+declare enum AppointmentStatus {
+    PENDING = "pending",// Initial state after booking, before confirmation (if applicable)
+    CONFIRMED = "confirmed",// Confirmed by clinic/practitioner
+    CHECKED_IN = "checked_in",// Patient has arrived
+    IN_PROGRESS = "in_progress",// Procedure has started
+    COMPLETED = "completed",// Procedure finished successfully
+    CANCELED_PATIENT = "canceled_patient",// Canceled by the patient
+    CANCELED_PATIENT_RESCHEDULED = "canceled_patient_rescheduled",// Canceled by the patient and rescheduled by the clinic
+    CANCELED_CLINIC = "canceled_clinic",// Canceled by the clinic/practitioner
+    NO_SHOW = "no_show",// Patient did not attend
+    RESCHEDULED_BY_CLINIC = "rescheduled_by_clinic"
+}
+/**
+ * Enum defining the payment status of an appointment.
+ */
+declare enum PaymentStatus {
+    UNPAID = "unpaid",
+    PAID = "paid",
+    PARTIALLY_PAID = "partially_paid",
+    REFUNDED = "refunded",
+    NOT_APPLICABLE = "not_applicable"
+}
+/**
+ * Enum for different types of media that can be attached to an appointment.
+ */
+declare enum MediaType {
+    BEFORE_PHOTO = "before_photo",
+    AFTER_PHOTO = "after_photo",
+    CONSENT_SCAN = "consent_scan",
+    OTHER_DOCUMENT = "other_document"
+}
+/**
+ * Interface to describe a media file linked to an appointment.
+ */
+interface AppointmentMediaItem {
+    id: string;
+    type: MediaType;
+    url: string;
+    fileName?: string;
+    uploadedAt: Timestamp;
+    uploadedBy: string;
+    description?: string;
+}
+/**
+ * Interface for procedure-specific information
+ */
+interface ProcedureExtendedInfo {
+    id: string;
+    name: string;
+    description: string;
+    cost: number;
+    duration: number;
+    procedureFamily: ProcedureFamily;
+    procedureCategoryId: string;
+    procedureCategoryName: string;
+    procedureSubCategoryId: string;
+    procedureSubCategoryName: string;
+    procedureTechnologyId: string;
+    procedureTechnologyName: string;
+    procedureProductBrandId: string;
+    procedureProductBrandName: string;
+    procedureProductId: string;
+    procedureProductName: string;
+}
+/**
+ * Interface to describe a filled form linked to an appointment.
+ */
+interface LinkedFormInfo {
+    formId: string;
+    templateId: string;
+    templateVersion: number;
+    title: string;
+    isUserForm: boolean;
+    status: FilledDocumentStatus;
+    path: string;
+    submittedAt?: Timestamp;
+    completedAt?: Timestamp;
+}
+/**
+ * Interface for summarized patient review information linked to an appointment.
+ */
+interface PatientReviewInfo {
+    reviewId: string;
+    rating: number;
+    comment?: string;
+    reviewedAt: Timestamp;
+}
+/**
+ * Represents a booked appointment, aggregating key information and relevant procedure rules.
+ */
+interface Appointment {
+    /** Unique identifier for the appointment */
+    id: string;
+    /** Reference to the associated CalendarEvent */
+    calendarEventId: string;
+    /** ID of the clinic branch */
+    clinicBranchId: string;
+    /** Aggregated clinic information (snapshot) */
+    clinicInfo: ClinicInfo;
+    /** ID of the practitioner */
+    practitionerId: string;
+    /** Aggregated practitioner information (snapshot) */
+    practitionerInfo: PractitionerProfileInfo;
+    /** ID of the patient */
+    patientId: string;
+    /** Aggregated patient information (snapshot) */
+    patientInfo: PatientProfileInfo;
+    /** ID of the procedure */
+    procedureId: string;
+    /** Aggregated procedure information including product/brand (snapshot) */
+    procedureInfo: ProcedureSummaryInfo;
+    /** Extended procedure information */
+    procedureExtendedInfo: ProcedureExtendedInfo;
+    /** Status of the appointment */
+    status: AppointmentStatus;
+    /** Timestamps */
+    bookingTime: Timestamp;
+    confirmationTime?: Timestamp | null;
+    cancellationTime?: Timestamp | null;
+    rescheduleTime?: Timestamp | null;
+    appointmentStartTime: Timestamp;
+    appointmentEndTime: Timestamp;
+    procedureActualStartTime?: Timestamp | null;
+    actualDurationMinutes?: number;
+    /** Cancellation Details */
+    cancellationReason?: string | null;
+    canceledBy?: "patient" | "clinic" | "practitioner" | "system";
+    /** Notes */
+    internalNotes?: string | null;
+    patientNotes?: string | null;
+    /** Payment Details */
+    cost: number;
+    currency: Currency;
+    paymentStatus: PaymentStatus;
+    paymentTransactionId?: string | null;
+    /** Procedure-related conditions and requirements */
+    blockingConditions: BlockingCondition[];
+    contraindications: Contraindication[];
+    preProcedureRequirements: Requirement[];
+    postProcedureRequirements: Requirement[];
+    /** Tracking information for requirements completion */
+    completedPreRequirements?: string[];
+    completedPostRequirements?: string[];
+    /** NEW: Linked forms (consent, procedure-specific forms, etc.) */
+    linkedFormIds?: string[];
+    linkedForms?: LinkedFormInfo[];
+    pendingUserFormsIds?: string[];
+    /** NEW: Media items (before/after photos, scanned documents, etc.) */
+    media?: AppointmentMediaItem[];
+    /** NEW: Information about the patient's review for this appointment */
+    reviewInfo?: PatientReviewInfo | null;
+    /** NEW: Details about the finalization of the appointment by the practitioner */
+    finalizedDetails?: {
+        by: string;
+        at: Timestamp;
+        notes?: string;
+    };
+    /** Timestamps for record creation and updates */
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    /** Recurring appointment information */
+    isRecurring?: boolean;
+    recurringAppointmentId?: string | null;
+    /** NEW: Flag for soft deletion or archiving */
+    isArchived?: boolean;
+}
+
+/**
+ * Interface for the data required by orchestrateAppointmentCreation
+ */
+interface OrchestrateAppointmentCreationData {
+    patientId: string;
+    procedureId: string;
+    appointmentStartTime: admin.firestore.Timestamp;
+    appointmentEndTime: admin.firestore.Timestamp;
+    patientNotes?: string | null;
+}
 /**
  * Admin service for handling booking-related operations.
  * This is the cloud-based implementation that will be used in Cloud Functions.
@@ -1776,6 +1973,20 @@ declare class BookingAdmin {
      * @returns Promise resolving to an array of calendar events
      */
     private getPractitionerCalendarEvents;
+    /**
+     * Orchestrates the creation of a new appointment, including data aggregation.
+     * This method is intended to be called from a trusted backend environment (e.g., an Express route handler in a Cloud Function).
+     *
+     * @param data - Data required to create the appointment.
+     * @param authenticatedUserId - The ID of the user making the request (for auditing, and usually is the patientId).
+     * @returns Promise resolving to an object indicating success, and appointmentId or an error message.
+     */
+    orchestrateAppointmentCreation(data: OrchestrateAppointmentCreationData, authenticatedUserId: string): Promise<{
+        success: boolean;
+        appointmentId?: string;
+        appointmentData?: Appointment;
+        error?: string;
+    }>;
 }
 
 /**